diff --git a/docs/templates/additional-content/information-about-x-feature.mdx b/docs/templates/additional-content/information-about-x-feature.mdx new file mode 100644 index 0000000000..40dd7b92d7 --- /dev/null +++ b/docs/templates/additional-content/information-about-x-feature.mdx @@ -0,0 +1,13 @@ +--- +title: "Information about 's feature " +description: Understand the Scaleway feature . +--- + +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. + diff --git a/docs/templates/additional-content/limitations.mdx b/docs/templates/additional-content/limitations.mdx new file mode 100644 index 0000000000..0b385f1d9b --- /dev/null +++ b/docs/templates/additional-content/limitations.mdx @@ -0,0 +1,10 @@ +--- +title: Limitations +description: Understand the limitations of . +--- + +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. \ No newline at end of file diff --git a/docs/templates/additional-content/product-features.mdx b/docs/templates/additional-content/product-features.mdx new file mode 100644 index 0000000000..8070180813 --- /dev/null +++ b/docs/templates/additional-content/product-features.mdx @@ -0,0 +1,50 @@ +--- +title: Information +description: Dive deeper into . +--- + +## 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 | diff --git a/docs/templates/api-cli.mdx b/docs/templates/api-cli.mdx new file mode 100644 index 0000000000..0ea8e32b1e --- /dev/null +++ b/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. + + +- 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 + ``` \ No newline at end of file diff --git a/docs/templates/concepts.mdx b/docs/templates/concepts.mdx new file mode 100644 index 0000000000..6ddc26e8b6 --- /dev/null +++ b/docs/templates/concepts.mdx @@ -0,0 +1,24 @@ +--- +title: " Concepts" +description: Understand key concepts related to Scaleway . +--- + +## 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 \ No newline at end of file diff --git a/docs/templates/faq.mdx b/docs/templates/faq.mdx new file mode 100644 index 0000000000..a8f8b3692f --- /dev/null +++ b/docs/templates/faq.mdx @@ -0,0 +1,28 @@ +--- +title: " FAQ" +description: Get answers to your most common -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. \ No newline at end of file diff --git a/docs/templates/how-tos.mdx b/docs/templates/how-tos.mdx new file mode 100644 index 0000000000..f4f31f5d79 --- /dev/null +++ b/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. + + + This page is a template, it gives an **example** display for the content type in question. + + + + +- 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. \ No newline at end of file diff --git a/docs/templates/index.mdx b/docs/templates/index.mdx new file mode 100644 index 0000000000..9e793ac790 --- /dev/null +++ b/docs/templates/index.mdx @@ -0,0 +1,69 @@ +--- +title: Documentation +description: Dive into Scaleway with our quickstart guides, how-tos and more. +--- + + + +## Getting Started + + + + + + + + +## FAQ + + + + + + + + +## Changelog + + diff --git a/docs/templates/menu.ts b/docs/templates/menu.ts new file mode 100644 index 0000000000..ded3288d78 --- /dev/null +++ b/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 ', + slug: 'create-a-', + }, + { + label: 'Manage the feature', + slug: 'manage-x', + }, + { + label: "Delete a ", + slug: "delete-a-" + } + ], + label: 'How to', + slug: 'how-to', + }, + { + items: [ + { + label: ' API Reference', + slug: 'https://www.scaleway.com/en/developers/api//', + }, + { + label: 'Creating a ', + slug: 'creating-a-', + }, + ], + label: 'API/CLI', + slug: 'api-cli', + }, + { + items: [ + { + label: ' features', + slug: '-features', + }, + { + label: ' limitations', + slug: '-limitations', + }, + { + label: 'Information about feature ', + slug: 'info-about-feature-x', + }, + ], + label: 'Additional Content', + slug: 'reference-content', + }, + { + label: 'Troubleshooting', + slug: 'troubleshooting', + }, + ], + label: '', + slug: '', +} diff --git a/docs/templates/quickstart.mdx b/docs/templates/quickstart.mdx new file mode 100644 index 0000000000..fefb4da49c --- /dev/null +++ b/docs/templates/quickstart.mdx @@ -0,0 +1,39 @@ +--- +title: " Quickstart" +description: Get started with the service in a few simple steps. +--- + +This guide walks users through creating their first product resource and performing a basic action. + + + This page is a template, it gives an **example** display for the content type in question. + + + + +- 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 + +## How to create the product via the console + +1. Click **Product Name** in the **Product Category** section of the Scaleway console side menu. + +2. Click **Create product**. The creation wizard displays. + +3. Complete the following steps in the wizard. + +## How to perform a basic action with the product + +1. Click **Product Name** in the **Product Category** section of the Scaleway console side menu. +2. Use the available controls to perform an action (e.g., start, connect, or configure). +3. Confirm the action was successful. + +## How to delete the product + + + Deleting the product will destroy all the data stored on it. + + +1. Click **Product Name** in the **Product Category** section of the Scaleway console side menu. +2. Click the icon next to the product you want to delete and select **Delete** from the drop-down menu. A pop-up asks you to confirm the action. +3. Type **DELETE** and then click **Delete Product**. \ No newline at end of file diff --git a/docs/templates/troubleshooting.mdx b/docs/templates/troubleshooting.mdx new file mode 100644 index 0000000000..2be22ca330 --- /dev/null +++ b/docs/templates/troubleshooting.mdx @@ -0,0 +1,40 @@ +--- +title: "Troubleshooting for Common Issue" +description: Diagnose and resolve a common problem. +--- + +This guide helps you identify and fix a common issue when using the service. + + + This page is a template, it gives an **example** display for the content type in question. + + + +## Problem + +A clear statement of the symptom or error message. + +## Possible Causes + +- Misconfigured setting +- Missing permission +- Resource in incorrect state +- Network or connectivity issue + +## Solutions + +### Solution 1: fix the configuration + +1. Open the resource settings. +2. Locate the relevant section. +3. Update the value to the correct option. +4. Save and restart if needed. + +### Solution 2: Check Permissions + +Ensure your user or API key has the required role: +- Required permission: `Resource-Modify` +- Verify using: + ```bash + scw whoami + ``` \ No newline at end of file