feat(gen): templates

Author: ldecarvalho-doc

docs/templates/additional-content.mdx

@@ -0,0 +1,80 @@
+---
+title: "API/CLI: Perform an Action"
+description: Use the API or CLI to perform a specific operation.
+---
+
+# API/CLI: Perform an Action
+
+This guide shows how to perform an operation using either the CLI or REST API.
+
+## Using the CLI
+
+### Install the CLI
+
+```bash
+curl -fsSL https://scaleway-cli.s3.fr-par.scw.cloud/install.sh | sh
+```
+
+### Configure Authentication
+
+```bash
+scw init
+```
+
+### Run the Command
+
+```bash
+scw service:action \
+  parameter1=value1 \
+  parameter2=value2 \
+  region=fr-par
+```
+
+### Expected Output
+
+```text
+ID: 123e4567-e89b-12d3-a456-426614174000
+Status: active
+```
+
+## Using the REST API
+
+### Endpoint
+
+```text
+POST /v1/zones/fr-par-1/resource/action
+```
+
+### Headers
+
+```text
+X-Auth-Token: your-api-key
+Content-Type: application/json
+```
+
+### Request Body
+
+```json
+{
+  "parameter1": "value1",
+  "parameter2": "value2"
+}
+```
+
+### Response
+
+```json
+{
+  "id": "123e4567-e89b-12d3-a456-426614174000",
+  "status": "active"
+}
+```
+
+## Parameters Reference
+
+| Parameter | Required | Description | Default |
+|---------|--------|------------|--------|
+| `parameter1` | Yes | Purpose of parameter | — |
+| `parameter2` | No | Optional setting | `default-value` |
+| `region` | Yes | Target region | `fr-par` |
+

docs/templates/api-cli.mdx

@@ -0,0 +1,29 @@
+---
+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 either the console or command-line interface.
+
+## Requirements
+
+- A running resource of the relevant type.
+- Access to the Scaleway Console or CLI.
+- Required permissions for the operation.
+
+## Step 1: Access the Resource
+
+1. Log in to the [Scaleway Console](https://console.scaleway.com).
+2. Navigate to the service dashboard.
+3. Locate and select your resource.
+
+## Step 2: Perform the Task
+
+1. In the resource interface, locate the relevant section.
+2. Click the appropriate button or run the command.
+3. Confirm the action.
+
+Example CLI command:
+```bash
+scw service:command parameter=value
+```

docs/templates/concepts.mdx

@@ -0,0 +1,83 @@
+---
+title: <Product name> Information
+description: Understand the autohealing feature for PostgreSQL and MySQL databases.
+dates:
+  validation: 2025-04-23
+categories:
+  - managed-databases
+  - postgresql-and-mysql
+---
+
+## 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
+
+## 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
+
+
+
+
+---
+title: "Service Overview"
+description: Introduction to the service, its features, and documentation structure.
+---
+
+# Service Overview
+
+This service provides capabilities for managing resources in a scalable and secure way.
+
+## Key Features
+
+- **Feature 1**: Description of functionality and benefit.
+- **Feature 2**: Scope and availability (e.g., multi-region).
+- **Feature 3**: Integration with other services.
+- **Feature 4**: Automation and API access.
+
+## 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 |
+
+## Getting Started
+
+- [Quickstart: Set Up a Resource](#)
+- [Concepts: Core Components](#)
+
+## Documentation Map
+
+| Topic | Guide |
+|------|-------|
+| How-tos | [Step-by-step tasks](#) |
+| Concepts | [Understanding the system](#) |
+| API/CLI | [Programmatic access](#) |
+| Troubleshooting | [Common issues](#) |
+| Release Notes | [Updates and changes](#) |
+```

docs/templates/faq.mdx

@@ -0,0 +1,51 @@
+---
+title: "Quickstart: Set Up a Resource"
+description: Get started with the service in a few simple steps.
+---
+
+## Quickstart
+
+A **Quickstart** helps new users complete a basic task or set up a resource in just a few steps.
+
+### Purpose
+To get users from zero to a working setup as quickly as possible — typically in under five minutes. It can:
+
+    - Introduce a new product or feature
+    - Help first-time users create their first resource
+    - Demonstrate core functionalities
+
+Understood — thank you for the clarification.
+
+
+
+# Quickstart: Set Up a Resource
+
+This guide walks you through creating your first resource and performing a basic action.
+
+## Requirements
+
+- You have a Scaleway account. [Create one here](https://console.scaleway.com/register) if needed.
+- You are logged in to the [Scaleway Console](https://console.scaleway.com).
+- You have the necessary permissions to create resources.
+
+## Create via Console
+
+1. Navigate to the service dashboard.
+2. Click **Create Resource**.
+3. Select a configuration template or image.
+4. Choose a region and instance type.
+5. Confirm and create the resource.
+
+## Perform a Basic Action
+
+Once the resource is active:
+1. Locate it in the dashboard.
+2. Use the available controls to perform an action (e.g., start, connect, or configure).
+3. Confirm the action was successful.
+
+## Next Steps
+
+- [Learn how to configure advanced settings](#)
+- [Explore the API/CLI options](#)
+- [Understand core concepts](#)
+```

docs/templates/how-tos.mdx

@@ -0,0 +1,51 @@
+---
+title: "Troubleshooting: Common Issue"
+description: Diagnose and resolve a common problem.
+---
+
+# Troubleshooting: Common Issue
+
+This guide helps you identify and fix a common issue when using the service.
+
+## Problem Description
+
+A clear statement of the symptom or error message.
+
+## Possible Causes
+
+- Misconfigured setting
+- Missing permission
+- Resource in incorrect state
+- Network or connectivity issue
+
+## 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
+  ```
+
+## Diagnostic Steps
+
+- View the system logs in the console.
+- Run a status check:
+  ```bash
+  scw service:status resource-id=123
+  ```
+
+## When to Contact Support
+
+If the issue persists after trying the above steps, contact support with:
+- Resource ID
+- Timestamp of the issue
+- Relevant logs or error messages
+```