Skip to content

Commit 0853765

Browse files
ldecarvalho-docldecarvalho-doc
committed
feat(gen): more templates
1 parent 1805fe3 commit 0853765

File tree

12 files changed

+355
-196
lines changed

12 files changed

+355
-196
lines changed

‎docs/templates/additional-content.mdx‎

Whitespace-only changes.

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Information about <Product Name>'s <X> feature "
3+
description: Understand the Scaleway <Product Name> feature <X>.
4+
---
5+
6+
Additional content pages are almost like blank canvases - you can write the information you like.
7+
8+
It is used to go deeper on certain subjects and concepts relating to the product.
9+
10+
You can create an additional page to describe the details and limitations of a feature, for example.
11+
12+
You can also create a page to describe how pricing works for the product.
13+

‎docs/templates/additional-content/limitations.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: <Product name> Limitations
3+
description: Understand the limitations of <Product Name>.
4+
---
5+
6+
List all the limitations of the product with descriptions.
7+
8+
If necessary you can create different sections.
9+
10+
Make sure you link to any relevant documentation page.

‎docs/templates/product-features.mdx‎ renamed to ‎docs/templates/additional-content/product-features.mdx‎

Lines changed: 14 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
---
22
title: <Product name> Information
3-
description: Understand the autohealing feature for PostgreSQL and MySQL databases.
4-
dates:
5-
validation: 2025-04-23
6-
categories:
7-
- managed-databases
8-
- postgresql-and-mysql
3+
description: Dive deeper into <Product Name>.
94
---
105

116
## Description (Mandatory)
@@ -20,6 +15,14 @@ Description of the product including:
2015
- Where does it place on the "compute abstraction" scale?
2116
- If it can be combined with other Scaleway products
2217

18+
### Use Cases
19+
20+
| Use Case | Description |
21+
|---------|-------------|
22+
| Web Hosting | Deploy and scale public-facing applications |
23+
| Data Processing | Run batch jobs with flexible compute options |
24+
| Private Networking | Isolate resources in a secure environment |
25+
2326
## Technical Information (If applicable)
2427

2528
- How it is built at Scaleway (If available)
@@ -39,45 +42,9 @@ List of features in alphabetical order, including:
3942
- currently integrated features
4043
- any features that are already in the roadmap and will be integrated in the near future
4144

45+
Example feature table:
4246

43-
44-
45-
---
46-
title: "Service Overview"
47-
description: Introduction to the service, its features, and documentation structure.
48-
---
49-
50-
# Service Overview
51-
52-
This service provides capabilities for managing resources in a scalable and secure way.
53-
54-
## Key Features
55-
56-
- **Feature 1**: Description of functionality and benefit.
57-
- **Feature 2**: Scope and availability (e.g., multi-region).
58-
- **Feature 3**: Integration with other services.
59-
- **Feature 4**: Automation and API access.
60-
61-
## Use Cases
62-
63-
| Use Case | Description |
64-
|---------|-------------|
65-
| Web Hosting | Deploy and scale public-facing applications |
66-
| Data Processing | Run batch jobs with flexible compute options |
67-
| Private Networking | Isolate resources in a secure environment |
68-
69-
## Getting Started
70-
71-
- [Quickstart: Set Up a Resource](#)
72-
- [Concepts: Core Components](#)
73-
74-
## Documentation Map
75-
76-
| Topic | Guide |
77-
|------|-------|
78-
| How-tos | [Step-by-step tasks](#) |
79-
| Concepts | [Understanding the system](#) |
80-
| API/CLI | [Programmatic access](#) |
81-
| Troubleshooting | [Common issues](#) |
82-
| Release Notes | [Updates and changes](#) |
83-
```
47+
| Feature | Description | Availability |
48+
|---------|-------------|---------|
49+
| Replication | Replicate data | Integrated |
50+
| Automatic backup | Set a schedule for your backups | Not yet integrated |

‎docs/templates/api-cli.mdx‎

Lines changed: 75 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,81 @@
11
---
2-
title: "API/CLI: Perform an Action"
2+
title: "How to perform an action using the API or the CLI"
33
description: Use the API or CLI to perform a specific operation.
44
---
55

6-
# API/CLI: Perform an Action
7-
86
This guide shows how to perform an operation using either the CLI or REST API.
97

10-
## Using the CLI
11-
12-
### Install the CLI
13-
14-
```bash
15-
curl -fsSL https://scaleway-cli.s3.fr-par.scw.cloud/install.sh | sh
16-
```
17-
18-
### Configure Authentication
19-
20-
```bash
21-
scw init
22-
```
23-
24-
### Run the Command
25-
26-
```bash
27-
scw service:action \
28-
parameter1=value1 \
29-
parameter2=value2 \
30-
region=fr-par
31-
```
32-
33-
### Expected Output
34-
35-
```text
36-
ID: 123e4567-e89b-12d3-a456-426614174000
37-
Status: active
38-
```
39-
40-
## Using the REST API
41-
42-
### Endpoint
43-
44-
```text
45-
POST /v1/zones/fr-par-1/resource/action
46-
```
47-
48-
### Headers
49-
50-
```text
51-
X-Auth-Token: your-api-key
52-
Content-Type: application/json
53-
```
54-
55-
### Request Body
56-
57-
```json
58-
{
59-
"parameter1": "value1",
60-
"parameter2": "value2"
61-
}
62-
```
63-
64-
### Response
65-
66-
```json
67-
{
68-
"id": "123e4567-e89b-12d3-a456-426614174000",
69-
"status": "active"
70-
}
71-
```
72-
73-
## Parameters Reference
74-
75-
| Parameter | Required | Description | Default |
76-
|---------|--------|------------|--------|
77-
| `parameter1` | Yes | Purpose of parameter | — |
78-
| `parameter2` | No | Optional setting | `default-value` |
79-
| `region` | Yes | Target region | `fr-par` |
80-
8+
<Requirements />
9+
- A Scaleway account logged into the [console](https://console.scaleway.com)
10+
- 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
11+
- You know your [Organization ID](https://console.scaleway.com/organization/settings)
12+
- You have [installed `curl`](https://curl.se/download.html)
13+
- Installed and initialized the [Scaleway CLI](https://www.scaleway.com/en/docs/scaleway-cli/quickstart/)
14+
15+
## Performing the action using the REST API
16+
17+
1. Edit the **POST** request payload you will use to perform the action. Replace the parameters in the following example:
18+
19+
```json
20+
'{
21+
"name": "my-resource-name",
22+
"organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
23+
"description": "Description of the resource",
24+
"region": "fr-par"
25+
}'
26+
```
27+
28+
| **Parameter** | **Description** |
29+
| --- | --- |
30+
| `name` | Name for the resource you want to create. |
31+
| `organization_id` | ID of the Organization in which to create the resource. Must be in UUID format. |
32+
| `description` | Optional description for the resource. |
33+
| `region` | Region where the resource will be created. Supported values: `fr-par`, `nl-ams`, `pl-waw`. |
34+
35+
3. Run the following command to create the resource. Make sure you include the payload you edited in the previous step.
36+
37+
```
38+
curl -X POST \
39+
40+
-H "X-Auth-Token: $SCW_SECRET_KEY" \
41+
-H "Content-Type: application/json" \
42+
"https://api.scaleway.com/service/v1/regions/fr-par/resource" \
43+
-d '{
44+
"name": "my-resource-name",
45+
"organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
46+
"description": "Description of the resource",
47+
"region": "fr-par"
48+
}'
49+
```
50+
You should get a response like the following:
51+
52+
```
53+
{
54+
"id": "111e89f4-a565-49ea-90da-073255490a67",
55+
"name": "my-resource-name",
56+
"organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
57+
"region": "fr-par",
58+
"status": "creating",
59+
"created_at": "2025-04-05T10:00:00.000000Z",
60+
"updated_at": "2025-04-05T10:00:00.000000Z",
61+
"description": "Description of the resource"
62+
}
63+
```
64+
65+
## Performing the action using the CLI
66+
67+
1. Run the following command to create the resource.
68+
69+
```bash
70+
scw service:action \
71+
parameter1=value1 \
72+
parameter2=value2 \
73+
region=fr-par
74+
```
75+
76+
You should see an output like the following:
77+
78+
```text
79+
ID: 123e4567-e89b-12d3-a456-426614174000
80+
Status: active
81+
```

‎docs/templates/concepts.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "<Product Name> Concepts"
3+
description: Understand key concepts related to Scaleway <Product Name>.
4+
---
5+
6+
## Concept 1
7+
8+
Definition of a concept relevant to the product in a couple sentences.
9+
10+
## Concept 2
11+
12+
Concepts are always organized in alphabetical order.
13+
14+
## Concept 3
15+
16+
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.
17+
18+
## Concept 4
19+
20+
Description
21+
22+
## Concept 4
23+
24+
Description

‎docs/templates/faq.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "<Product Name> FAQ"
3+
description: Get answers to your most common <Product Name>-related questions.
4+
---
5+
6+
## Question category 1
7+
8+
### What should my first question be?
9+
10+
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.
11+
12+
### Question 2
13+
14+
Answer.
15+
16+
## Question category 2
17+
18+
### How long should an answer be?
19+
20+
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.
21+
22+
### Question 2
23+
24+
Answer.
25+
26+
### Question 3
27+
28+
Answer.

‎docs/templates/how-tos.mdx‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
11
---
2-
title: "How to Perform a Specific Task"
2+
title: "How to perform a specific task"
33
description: Step-by-step instructions for completing a specific task.
44
---
55

6-
This guide shows how to complete a specific task using either the console or command-line interface.
6+
This guide shows how to complete a specific task using the console.
77

8-
## Requirements
8+
<Message type="important">
9+
This page is a template, it gives an **example** display for the content type in question.
10+
</Message>
911

10-
- A running resource of the relevant type.
11-
- Access to the Scaleway Console or CLI.
12-
- Required permissions for the operation.
12+
<Requirements />
1313

14-
## Step 1: Access the Resource
14+
- A Scaleway account logged into the [console](https://console.scaleway.com)
15+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
1516

16-
1. Log in to the [Scaleway Console](https://console.scaleway.com).
17-
2. Navigate to the service dashboard.
18-
3. Locate and select your resource.
17+
1. Click **Product Name** in the **Product Category** section of the Scaleway console side menu.
1918

20-
## Step 2: Perform the Task
19+
2. Click **Perform task**. A pop-up displays.
2120

22-
1. In the resource interface, locate the relevant section.
23-
2. Click the appropriate button or run the command.
24-
3. Confirm the action.
21+
3. Complete the steps.
2522

26-
Example CLI command:
27-
```bash
28-
scw service:command parameter=value
29-
```
23+
4. Click **Confirm** to conclude.

0 commit comments

Comments
 (0)