feat(gen): templates for doc pages - MTA-6283

docs/templates/additional-content/information-about-x-feature.mdx

@@ -0,0 +1,13 @@
+---
+title: "Information about <Product Name>'s <X> feature "
+description: Understand the Scaleway <Product Name> feature <X>.
+---
+
+Additional content pages are almost like blank canvases - you can write the information you like.
+
+It is used to go deeper on certain subjects and concepts relating to the product.
+
+You can create an additional page to describe the details and limitations of a feature, for example.
+
+You can also create a page to describe how pricing works for the product.
+

docs/templates/additional-content/limitations.mdx

@@ -0,0 +1,10 @@
+---
+title: <Product name> Limitations
+description: Understand the limitations of <Product Name>.
+---
+
+List all the limitations of the product with descriptions.
+
+If necessary you can create different sections.
+
+Make sure you link to any relevant documentation page.

docs/templates/additional-content/product-features.mdx

@@ -0,0 +1,50 @@
+---
+title: <Product name> Information
+description: Dive deeper into <Product Name>.
+---
+
+## Description (Mandatory)
+
+Description of the product including:
+
+  - What it does
+  - Its advantages (summary of most important features)
+  - Use cases
+
+  Optional:
+  - Where does it place on the "compute abstraction" scale?
+  - If it can be combined with other Scaleway products
+
+### Use Cases
+
+| Use Case | Description |
+|---------|-------------|
+| Web Hosting | Deploy and scale public-facing applications |
+| Data Processing | Run batch jobs with flexible compute options |
+| Private Networking | Isolate resources in a secure environment |
+
+## Technical Information (If applicable)
+
+  - How it is built at Scaleway (If available)
+  - Diagrams (If available)
+  - Requirements to use the product (If applicable)
+  - Can it be integrated with other Scaleway products?
+
+## Pricing (Mandatory)
+
+  - Explain pricing (If explanation is available)
+  - Add any information that might be interesting about pricing
+  - Add link to pricing page (Mandatory)
+
+## Features (Mandatory)
+
+List of features in alphabetical order, including:
+  - currently integrated features
+  - any features that are already in the roadmap and will be integrated in the near future
+
+Example feature table:
+
+| Feature | Description | Availability |
+|---------|-------------|---------|
+| Replication | Replicate data | Integrated |
+| Automatic backup | Set a schedule for your backups | Not yet integrated |

docs/templates/api-cli.mdx

@@ -0,0 +1,81 @@
+---
+title: "How to perform an action using the API or the CLI"
+description: Use the API or CLI to perform a specific operation.
+---
+
+This guide shows how to perform an operation using either the CLI or REST API.
+
+<Requirements />
+- A Scaleway account logged into the [console](https://console.scaleway.com)
+- You have created an [API key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/iam/reference-content/permission-sets/) to perform the actions described on this page
+- You know your [Organization ID](https://console.scaleway.com/organization/settings)
+- You have [installed `curl`](https://curl.se/download.html)
+- Installed and initialized the [Scaleway CLI](https://www.scaleway.com/en/docs/scaleway-cli/quickstart/)
+
+## Performing the action using the REST API
+
+1. Edit the **POST** request payload you will use to perform the action. Replace the parameters in the following example:
+
+    ```json
+    '{
+        "name": "my-resource-name",
+        "organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
+        "description": "Description of the resource",
+        "region": "fr-par"
+    }'
+    ```
+
+    | **Parameter** | **Description** |
+    | --- | --- |
+    | `name` | Name for the resource you want to create. |
+    | `organization_id` | ID of the Organization in which to create the resource. Must be in UUID format. |
+    | `description` | Optional description for the resource. |
+    | `region` | Region where the resource will be created. Supported values: `fr-par`, `nl-ams`, `pl-waw`. |
+
+3. Run the following command to create the resource. Make sure you include the payload you edited in the previous step.
+
+    ```
+    curl -X POST \
+
+      -H "X-Auth-Token: $SCW_SECRET_KEY" \
+      -H "Content-Type: application/json" \
+      "https://api.scaleway.com/service/v1/regions/fr-par/resource" \
+      -d '{
+          "name": "my-resource-name",
+          "organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
+          "description": "Description of the resource",
+          "region": "fr-par"
+        }'
+    ```
+    You should get a response like the following:
+
+    ```
+    {
+      "id": "111e89f4-a565-49ea-90da-073255490a67",
+      "name": "my-resource-name",
+      "organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
+      "region": "fr-par",
+      "status": "creating",
+      "created_at": "2025-04-05T10:00:00.000000Z",
+      "updated_at": "2025-04-05T10:00:00.000000Z",
+      "description": "Description of the resource"
+    }
+    ```
+
+## Performing the action using the CLI
+
+1. Run the following command to create the resource.
+
+    ```bash
+    scw service:action \
+      parameter1=value1 \
+      parameter2=value2 \
+      region=fr-par
+    ```
+
+    You should see an output like the following:
+
+    ```text
+    ID: 123e4567-e89b-12d3-a456-426614174000
+    Status: active
+    ```

docs/templates/concepts.mdx

@@ -0,0 +1,24 @@
+---
+title: "<Product Name> Concepts"
+description: Understand key concepts related to Scaleway <Product Name>.
+---
+
+## Concept 1
+
+Definition of a concept relevant to the product in a couple sentences.
+
+## Concept 2
+
+Concepts are always organized in alphabetical order.
+
+## Concept 3
+
+If the concept is longer than a couple paragraphs, this might warrant the creation of a [dedicated Additional Content page](/templates/additional-content), that you can link to in the concept.
+
+## Concept 4
+
+Description
+
+## Concept 4
+
+Description

docs/templates/faq.mdx

@@ -0,0 +1,28 @@
+---
+title: "<Product Name> FAQ"
+description: Get answers to your most common <Product Name>-related questions.
+---
+
+## Question category 1
+
+### What should my first question be?
+
+You can add any questions (and answers) you think might help the users better use and understand the product. Add links to useful docs to complement the information.
+
+### Question 2
+
+Answer.
+
+## Question category 2
+
+### How long should an answer be?
+
+If the answer is longer than a couple paragraphs, that might warrant the creation of a [dedicated Additional Content page](/templates/additional-content), that you can link to in the FAQ.
+
+### Question 2
+
+Answer.
+
+### Question 3
+
+Answer.

docs/templates/how-tos.mdx

@@ -0,0 +1,23 @@
+---
+title: "How to perform a specific task"
+description: Step-by-step instructions for completing a specific task.
+---
+
+This guide shows how to complete a specific task using the console.
+
+<Message type="important">
+  This page is a template, it gives an **example** display for the content type in question.
+</Message>
+
+<Requirements />
+
+- A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+
+1. Click **Product Name** in the **Product Category** section of the Scaleway console side menu.
+
+2. Click **Perform task**. A pop-up displays.
+
+3. Complete the steps.
+
+4. Click **Confirm** to conclude.

docs/templates/index.mdx

@@ -0,0 +1,69 @@
+---
+title: <Product Name> Documentation
+description: Dive into Scaleway <Product Name> with our quickstart guides, how-tos and more.
+---
+
+<ProductHeader
+   productName="<Product Name>"
+   productLogo="possible logos can be found here: https://storybook.ultraviolet.scaleway.com/?path=/docs/illustrations-wireillustration--docs"
+   description="<Product Name> management features provide a comprehensive overview of our <product-name> features that help you monitor and understand your Scaleway cloud expenditure, pay your invoice, and effectively manage your budget."
+   url="/<product-name>/quickstart"
+   label="<Product Name> Quickstart"
+/>
+
+## Getting Started
+
+<Grid>
+    <SummaryCard
+        title="Quickstart"
+        icon="rocket"
+        description="Learn how to add and manage your <product-name> information in a few steps."
+        label="View Quickstart"
+        url="/<product-name>/quickstart"
+    />
+    <SummaryCard
+        title="Concepts"
+        icon="info"
+        description="Core concepts that give you a better understanding of Scaleway <product-name>."
+        label="View Concepts"
+        url="/<product-name>/concepts"
+    />
+    <SummaryCard
+        title="How-tos"
+        icon="help-circle-outline"
+        description="Check our guides to add and manage <product-name> information"
+        label="View How-tos"
+        url="/<product-name>/how-to/"
+    />
+
+</Grid>
+
+## FAQ
+
+<Grid>
+    <Card
+        title="How does the pricing work for <Product Name>?"
+        url="/<product-name>/faq/#how-am-i-billed-for-scaleway-services"
+        label="Read more"
+    />
+    <Card
+        title="What regions is <Product Name> available in?"
+        url="/<product-name>/faq/#when-are-invoices-issued"
+        label="Read more"
+    />
+</Grid>
+
+<ClickableBanner
+    productLogo="cli"
+    title="<Product Name> API"
+    description="Learn how to manage Scaleway's <product-name> through the API."
+    url="https://www.scaleway.com/en/developers/api/<product-name>/"
+    label="Go to the <product-name> API"
+/>
+
+## Changelog
+
+<ChangelogList
+    productName="<product-name>"
+    numberOfChanges={3}
+/>

docs/templates/menu.ts

@@ -0,0 +1,76 @@
+export const productnameMenu = {
+  items: [
+    {
+      label: 'Overview',
+      slug: '../<>',
+    },
+    {
+      label: 'Concepts',
+      slug: 'concepts',
+    },
+    {
+      label: 'Quickstart',
+      slug: 'quickstart',
+    },
+    {
+      label: 'FAQ',
+      slug: 'faq',
+    },
+    {
+      items: [
+        {
+          label: 'Create a <product-name>',
+          slug: 'create-a-<product-name>',
+        },
+        {
+          label: 'Manage the <X> feature',
+          slug: 'manage-x',
+        },
+        {
+          label: "Delete a <product-name>",
+          slug: "delete-a-<product-name>"
+        }
+      ],
+      label: 'How to',
+      slug: 'how-to',
+    },
+    {
+      items: [
+        {
+          label: '<Product Name> API Reference',
+          slug: 'https://www.scaleway.com/en/developers/api/<product-name>/',
+        },
+        {
+          label: 'Creating a <product-name>',
+          slug: 'creating-a-<product-name>',
+        },
+      ],
+      label: 'API/CLI',
+      slug: 'api-cli',
+    },
+    {
+      items: [
+        {
+          label: '<Product Name> features',
+          slug: '<product-name>-features',
+        },
+        {
+          label: '<Product Name> limitations',
+          slug: '<product-name>-limitations',
+        },
+        {
+          label: 'Information about feature <X>',
+          slug: 'info-about-feature-x',
+        },
+      ],
+      label: 'Additional Content',
+      slug: 'reference-content',
+    },
+    {
+      label: 'Troubleshooting',
+      slug: 'troubleshooting',
+    },
+  ],
+  label: '<Product Name>',
+  slug: '<product-name>',
+}