From d8598e195e1460b18acbe86c136a23d259318962 Mon Sep 17 00:00:00 2001 From: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> Date: Tue, 15 Jul 2025 16:05:36 +0200 Subject: [PATCH 1/5] feat(gen): features page --- .../reference-content/product-features.mdx | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx diff --git a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx new file mode 100644 index 0000000000..c7790a89c3 --- /dev/null +++ b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx @@ -0,0 +1,36 @@ +--- +title: Understanding the autohealing feature +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's built (If available) + - Diagrams (If available) + - Requirements to use the product (If applicable) + - Can it be integrated with other Scaleway products? + +## 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 + + From 84f14874ae38dfb271ec022d07984faafeef84fb Mon Sep 17 00:00:00 2001 From: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> Date: Tue, 15 Jul 2025 17:26:01 +0200 Subject: [PATCH 2/5] feat(gen): pricing --- .../reference-content/product-features.mdx | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx index c7790a89c3..aaecd0157f 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx @@ -1,5 +1,5 @@ --- -title: Understanding the autohealing feature +title: Information description: Understand the autohealing feature for PostgreSQL and MySQL databases. dates: validation: 2025-04-23 @@ -22,11 +22,17 @@ Description of the product including: ## Technical Information (If applicable) - - How it's built (If available) + - 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: @@ -34,3 +40,4 @@ List of features in alphabetical order, including: - any features that are already in the roadmap and will be integrated in the near future + From f71fbfef8eab7bfb84cc0031439b41bf5259949f Mon Sep 17 00:00:00 2001 From: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> Date: Mon, 10 Nov 2025 17:53:55 +0100 Subject: [PATCH 3/5] fix(gen): templates --- .../reference-content/product-features.mdx | 390 ++++++++++++++++++ 1 file changed, 390 insertions(+) diff --git a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx index aaecd0157f..83fd8edc25 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx @@ -41,3 +41,393 @@ List of features in alphabetical order, including: +Got it — clean, professional Markdown without any emojis. Here's the full set of templates in pure copiable format, with YAML frontmatter and no extra text or emojis. + +--- + +```markdown +--- +title: "Quickstart: Create an Instance" +description: Get started with Scaleway Instances in less than 5 minutes. +--- + +# Quickstart: Create an Instance + +This guide shows you how to create and connect to a Scaleway Instance in just a few steps. + +## Requirements + +- You have a Scaleway account. [Create one here](https://console.scaleway.com/register). +- You are logged in to the [Scaleway Console](https://console.scaleway.com). +- You have created an API key (optional for CLI steps). + +## Create via Console + +1. Go to the **Compute > Instances** section in the console. +2. Click **Create an Instance**. +3. Choose an image (e.g., Ubuntu 22.04). +4. Select an instance type (e.g., DEV1-S). +5. Choose a region (e.g., `fr-par-1`). +6. Click **Create Instance**. + +The root password will be sent to your email. + +## Connect via SSH + +Once the instance is running: + +```bash +ssh root@ +``` + +Tip: Use SSH keys for better security. See [managing SSH keys](https://www.scaleway.com/en/docs/compute/instance/how-to/connect-using-ssh-keys/). + +## Next Steps + +- [Customize your instance](https://www.scaleway.com/en/docs/compute/instance/how-to/configure-instance/) +- [Set up a private network](https://www.scaleway.com/en/docs/network/vpc/quickstart/) +- [Explore the API](https://www.scaleway.com/en/docs/compute/instance/api/reference/) +``` + +```markdown +--- +title: "How to Connect to an Instance Using SSH Keys" +description: Learn how to securely connect to your Scaleway Instance using SSH keys. +--- + +# How to Connect to an Instance Using SSH Keys + +This guide explains how to use SSH keys to connect to your Scaleway Instance instead of using passwords. + +## Prerequisites + +- A running Scaleway Instance. +- SSH key pair generated (`id_rsa` and `id_rsa.pub`, or use `ssh-keygen`). + +## Step 1: Add Your Public Key in the Console + +1. Go to **Compute > Instances**. +2. In the left sidebar, click **SSH Keys**. +3. Click **Add an SSH key**. +4. Enter a name (e.g., `my-laptop`) and paste your public key (the content of `id_rsa.pub`). +5. Click **Add**. + +## Step 2: Attach Key During Instance Creation + +When creating a new instance: +- In the **Security** section, select your SSH key. +- The instance will allow SSH access using your private key. + +## Step 3: Connect via SSH + +```bash +ssh root@ +``` + +No password needed if your key is set up correctly. + +## Troubleshooting + +- **Error: Permission denied (publickey)** + Ensure your SSH agent is running: + ```bash + eval $(ssh-agent) + ssh-add ~/.ssh/id_rsa + ``` + +- **Key not loading?** + Confirm the public key in the console matches your `.pub` file. + +## Related Content + +- [Instance Quickstart](https://www.scaleway.com/en/docs/compute/instance/quickstart/) +- [Managing SSH Keys via API](https://www.scaleway.com/en/docs/compute/instance/api/reference/#operation/CreateServer) +``` + +```markdown +--- +title: "Concepts: Bootscripts" +description: Understand what bootscripts are and how they control instance startup. +--- + +# Concepts: Bootscripts + +A **bootscript** is a predefined configuration that tells a Scaleway Instance which kernel and initrd to load at boot time. + +## Why Use Bootscripts? + +Bootscripts allow you to: +- Boot from custom kernels. +- Enable specific features like rescue mode. +- Use alternative operating systems. + +## Types of Bootscripts + +| Type | Description | +|------|-------------| +| `normal` | Standard boot using the default kernel. | +| `rescue` | Boots into a minimal environment for troubleshooting. | +| `boot2docker` | Legacy mode for Docker hosts (deprecated). | + +## Default Behavior + +When you create an instance: +- The system automatically assigns a compatible bootscript based on the selected image. +- You can override this in the API or console. + +## Example Use Case + +You want to debug a misconfigured firewall: +1. Stop the instance. +2. Change bootscript to `rescue`. +3. Restart and access via SSH. +4. Modify configuration files directly. + +Related: [How to use rescue mode](https://www.scaleway.com/en/docs/compute/instance/how-to/use-rescue-mode/) + +## Limitations + +- Not all instance types support all bootscripts. +- ARM64 instances have limited bootscript options. + +## Learn More + +- [Image Concepts](https://www.scaleway.com/en/docs/compute/instance/concepts/image/) +- [Instance API Reference](https://www.scaleway.com/en/docs/compute/instance/api/reference/) +``` + +```markdown +--- +title: "Troubleshooting: Instance Won't Boot" +description: Diagnose and fix issues when a Scaleway Instance fails to start. +--- + +# Troubleshooting: Instance Won't Boot + +If your Scaleway Instance fails to start or remains stuck in "starting" state, follow these steps. + +## 1. Check Instance Status + +In the **Instances** dashboard: +- Is the status `starting`, `error`, or `stopped`? +- Are there any alerts or messages? + +Tip: Wait up to 2 minutes after creation; some images take longer. + +## 2. Verify Bootscript and Image Compatibility + +An incompatible bootscript can prevent booting. + +Fix: +- Go to instance settings. +- Ensure the bootscript matches the image (e.g., `normal` for most Linux images). + +## 3. Inspect the Boot Logs + +1. In the console, go to your instance. +2. Click **Boot Logs**. +3. Look for: + - Kernel panic + - Missing root device + - Filesystem errors + +Example: `VFS: Unable to mount root fs` → corrupted image or volume. + +## 4. Try Rescue Mode + +Boot into rescue mode to inspect the filesystem: + +1. Stop the instance. +2. Edit → Change bootscript to `rescue`. +3. Start the instance. +4. Connect via SSH and run: + ```bash + fsck /dev/root + ``` + +## 5. Reattach the Boot Volume + +Sometimes the volume becomes detached. + +Fix: +- Detach and reattach the boot volume in the **Volumes** tab. + +## Still Not Working? + +Contact Scaleway Support with: +- Instance ID +- Screenshot of boot logs +- Steps already tried + +Open a support ticket: https://www.scaleway.com/en/support/ +``` + +```markdown +--- +title: "API/CLI: Create an Instance" +description: Use the Scaleway API or CLI to programmatically create an Instance. +--- + +# API/CLI: Create an Instance + +Automate infrastructure with the Scaleway 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 Credentials + +```bash +scw init +``` + +Follow prompts to enter your **Organization ID** and **API Key**. + +### Create Command + +```bash +scw instance server create \ + image=ubuntu_jammy \ + type=DEV1-S \ + region=fr-par \ + name=my-cli-instance +``` + +### Output + +```bash +ID: 111e89f4-a565-49ea-90da-073255490a67 +IP: 51.159.20.30 +Status: running +``` + +## Using the REST API + +**Endpoint**: +`POST https://api.scaleway.com/instance/v1/zones/fr-par-1/servers` + +**Headers**: +``` +X-Auth-Token: your-api-key +Content-Type: application/json +``` + +**Body**: +```json +{ + "image": "ubuntu_jammy", + "type": "DEV1-S", + "name": "api-instance", + "zone": "fr-par-1" +} +``` + +**Response**: +```json +{ + "server": { + "id": "111e89f4-a565-49ea-90da-073255490a67", + "public_ip": { "address": "51.159.20.30" } + } +} +``` + +## Parameters Reference + +| Parameter | Required | Description | +|---------|--------|------------| +| `image` | Yes | OS image identifier | +| `type` | Yes | Instance size | +| `zone` | Yes | e.g., `fr-par-1` | +| `name` | No | Default: auto-generated | + +## Learn More + +- [CLI Installation Guide](https://www.scaleway.com/en/docs/cli/) +- [API Authentication](https://www.scaleway.com/en/docs/api-reference/#authentication) +``` + +```markdown +--- +title: "Instance Product Overview" +description: Introduction to Scaleway Instances — virtual machines with high performance and flexibility. +--- + +# Instance Product Overview + +Scaleway Instances provide on-demand virtual machines with predictable pricing, high performance, and full control. + +## Key Features + +- Bare-metal and virtual instances +- Multi-region deployment +- Wide range of images +- SSH key management +- Flexible storage + +## Use Cases + +| Use Case | Why Choose Instances | +|--------|----------------------| +| Web Hosting | Full control over environment | +| CI/CD Runner | Isolated, reproducible builds | +| Game Server | Low-latency, high-performance nodes | + +## Getting Started + +Quickstart: +[Create your first instance](/docs/compute/instance/quickstart/) + +Concepts: +[Understand images and bootscripts](/docs/compute/instance/concepts/) + +## Documentation Map + +| Topic | Link | +|------|------| +| How-tos | [All guides](/docs/compute/instance/how-to/) | +| API Reference | [REST & CLI](/docs/compute/instance/api/reference/) | +| Troubleshooting | [Common issues](/docs/compute/instance/troubleshooting/) | +| Changelog | [Release notes](/docs/compute/instance/releases/) | +``` + +```markdown +--- +title: "Release Notes: Instance Updates" +description: Stay up to date with the latest features and fixes for Scaleway Instances. +--- + +# Release Notes: Instance Updates + +## May 2025 + +### New Features +- Added support for `ARM64-128GB` instance type. +- New Ubuntu 24.04 LTS image available. + +### Improvements +- Faster boot times for `GP-S` instances. +- Improved volume detachment handling. + +### Fixes +- Fixed rare crash during live migration. +- Resolved issue with API returning 503 during peak hours. + +## April 2025 + +### New +- New `rescue-buster` bootscript for Debian 10 compatibility. + +### Fixed +- Fixed incorrect disk size display in console. + +All users are automatically updated. No action required. + +Subscribe to updates: +[Email notifications](https://www.scaleway.com/en/support/) | [RSS Feed](https://www.scaleway.com/en/docs/compute/instance/releases/index.xml) +``` \ No newline at end of file From 1805fe3555f8aa5f8803cf80a02d229ed85332f4 Mon Sep 17 00:00:00 2001 From: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> Date: Thu, 13 Nov 2025 14:43:06 +0100 Subject: [PATCH 4/5] feat(gen): templates --- docs/templates/additional-content.mdx | 0 docs/templates/api-cli.mdx | 80 ++++ docs/templates/concepts.mdx | 0 docs/templates/faq.mdx | 0 docs/templates/how-tos.mdx | 29 ++ docs/templates/index.mdx | 0 docs/templates/menu.ts | 0 docs/templates/product-features.mdx | 83 ++++ docs/templates/quickstart.mdx | 51 +++ docs/templates/troubleshooting.mdx | 51 +++ .../reference-content/product-features.mdx | 433 ------------------ 11 files changed, 294 insertions(+), 433 deletions(-) create mode 100644 docs/templates/additional-content.mdx create mode 100644 docs/templates/api-cli.mdx create mode 100644 docs/templates/concepts.mdx create mode 100644 docs/templates/faq.mdx create mode 100644 docs/templates/how-tos.mdx create mode 100644 docs/templates/index.mdx create mode 100644 docs/templates/menu.ts create mode 100644 docs/templates/product-features.mdx create mode 100644 docs/templates/quickstart.mdx create mode 100644 docs/templates/troubleshooting.mdx delete mode 100644 pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx diff --git a/docs/templates/additional-content.mdx b/docs/templates/additional-content.mdx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/templates/api-cli.mdx b/docs/templates/api-cli.mdx new file mode 100644 index 0000000000..39b16be7ab --- /dev/null +++ b/docs/templates/api-cli.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` | + diff --git a/docs/templates/concepts.mdx b/docs/templates/concepts.mdx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/templates/faq.mdx b/docs/templates/faq.mdx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/templates/how-tos.mdx b/docs/templates/how-tos.mdx new file mode 100644 index 0000000000..0b8fa7d596 --- /dev/null +++ b/docs/templates/how-tos.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 +``` \ No newline at end of file diff --git a/docs/templates/index.mdx b/docs/templates/index.mdx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/templates/menu.ts b/docs/templates/menu.ts new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/templates/product-features.mdx b/docs/templates/product-features.mdx new file mode 100644 index 0000000000..d917267dff --- /dev/null +++ b/docs/templates/product-features.mdx @@ -0,0 +1,83 @@ +--- +title: 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](#) | +``` diff --git a/docs/templates/quickstart.mdx b/docs/templates/quickstart.mdx new file mode 100644 index 0000000000..118754c2c7 --- /dev/null +++ b/docs/templates/quickstart.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](#) +``` \ No newline at end of file diff --git a/docs/templates/troubleshooting.mdx b/docs/templates/troubleshooting.mdx new file mode 100644 index 0000000000..ef08882adc --- /dev/null +++ b/docs/templates/troubleshooting.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 +``` \ No newline at end of file diff --git a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx b/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx deleted file mode 100644 index 83fd8edc25..0000000000 --- a/pages/managed-databases-for-postgresql-and-mysql/reference-content/product-features.mdx +++ /dev/null @@ -1,433 +0,0 @@ ---- -title: 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 - - - -Got it — clean, professional Markdown without any emojis. Here's the full set of templates in pure copiable format, with YAML frontmatter and no extra text or emojis. - ---- - -```markdown ---- -title: "Quickstart: Create an Instance" -description: Get started with Scaleway Instances in less than 5 minutes. ---- - -# Quickstart: Create an Instance - -This guide shows you how to create and connect to a Scaleway Instance in just a few steps. - -## Requirements - -- You have a Scaleway account. [Create one here](https://console.scaleway.com/register). -- You are logged in to the [Scaleway Console](https://console.scaleway.com). -- You have created an API key (optional for CLI steps). - -## Create via Console - -1. Go to the **Compute > Instances** section in the console. -2. Click **Create an Instance**. -3. Choose an image (e.g., Ubuntu 22.04). -4. Select an instance type (e.g., DEV1-S). -5. Choose a region (e.g., `fr-par-1`). -6. Click **Create Instance**. - -The root password will be sent to your email. - -## Connect via SSH - -Once the instance is running: - -```bash -ssh root@ -``` - -Tip: Use SSH keys for better security. See [managing SSH keys](https://www.scaleway.com/en/docs/compute/instance/how-to/connect-using-ssh-keys/). - -## Next Steps - -- [Customize your instance](https://www.scaleway.com/en/docs/compute/instance/how-to/configure-instance/) -- [Set up a private network](https://www.scaleway.com/en/docs/network/vpc/quickstart/) -- [Explore the API](https://www.scaleway.com/en/docs/compute/instance/api/reference/) -``` - -```markdown ---- -title: "How to Connect to an Instance Using SSH Keys" -description: Learn how to securely connect to your Scaleway Instance using SSH keys. ---- - -# How to Connect to an Instance Using SSH Keys - -This guide explains how to use SSH keys to connect to your Scaleway Instance instead of using passwords. - -## Prerequisites - -- A running Scaleway Instance. -- SSH key pair generated (`id_rsa` and `id_rsa.pub`, or use `ssh-keygen`). - -## Step 1: Add Your Public Key in the Console - -1. Go to **Compute > Instances**. -2. In the left sidebar, click **SSH Keys**. -3. Click **Add an SSH key**. -4. Enter a name (e.g., `my-laptop`) and paste your public key (the content of `id_rsa.pub`). -5. Click **Add**. - -## Step 2: Attach Key During Instance Creation - -When creating a new instance: -- In the **Security** section, select your SSH key. -- The instance will allow SSH access using your private key. - -## Step 3: Connect via SSH - -```bash -ssh root@ -``` - -No password needed if your key is set up correctly. - -## Troubleshooting - -- **Error: Permission denied (publickey)** - Ensure your SSH agent is running: - ```bash - eval $(ssh-agent) - ssh-add ~/.ssh/id_rsa - ``` - -- **Key not loading?** - Confirm the public key in the console matches your `.pub` file. - -## Related Content - -- [Instance Quickstart](https://www.scaleway.com/en/docs/compute/instance/quickstart/) -- [Managing SSH Keys via API](https://www.scaleway.com/en/docs/compute/instance/api/reference/#operation/CreateServer) -``` - -```markdown ---- -title: "Concepts: Bootscripts" -description: Understand what bootscripts are and how they control instance startup. ---- - -# Concepts: Bootscripts - -A **bootscript** is a predefined configuration that tells a Scaleway Instance which kernel and initrd to load at boot time. - -## Why Use Bootscripts? - -Bootscripts allow you to: -- Boot from custom kernels. -- Enable specific features like rescue mode. -- Use alternative operating systems. - -## Types of Bootscripts - -| Type | Description | -|------|-------------| -| `normal` | Standard boot using the default kernel. | -| `rescue` | Boots into a minimal environment for troubleshooting. | -| `boot2docker` | Legacy mode for Docker hosts (deprecated). | - -## Default Behavior - -When you create an instance: -- The system automatically assigns a compatible bootscript based on the selected image. -- You can override this in the API or console. - -## Example Use Case - -You want to debug a misconfigured firewall: -1. Stop the instance. -2. Change bootscript to `rescue`. -3. Restart and access via SSH. -4. Modify configuration files directly. - -Related: [How to use rescue mode](https://www.scaleway.com/en/docs/compute/instance/how-to/use-rescue-mode/) - -## Limitations - -- Not all instance types support all bootscripts. -- ARM64 instances have limited bootscript options. - -## Learn More - -- [Image Concepts](https://www.scaleway.com/en/docs/compute/instance/concepts/image/) -- [Instance API Reference](https://www.scaleway.com/en/docs/compute/instance/api/reference/) -``` - -```markdown ---- -title: "Troubleshooting: Instance Won't Boot" -description: Diagnose and fix issues when a Scaleway Instance fails to start. ---- - -# Troubleshooting: Instance Won't Boot - -If your Scaleway Instance fails to start or remains stuck in "starting" state, follow these steps. - -## 1. Check Instance Status - -In the **Instances** dashboard: -- Is the status `starting`, `error`, or `stopped`? -- Are there any alerts or messages? - -Tip: Wait up to 2 minutes after creation; some images take longer. - -## 2. Verify Bootscript and Image Compatibility - -An incompatible bootscript can prevent booting. - -Fix: -- Go to instance settings. -- Ensure the bootscript matches the image (e.g., `normal` for most Linux images). - -## 3. Inspect the Boot Logs - -1. In the console, go to your instance. -2. Click **Boot Logs**. -3. Look for: - - Kernel panic - - Missing root device - - Filesystem errors - -Example: `VFS: Unable to mount root fs` → corrupted image or volume. - -## 4. Try Rescue Mode - -Boot into rescue mode to inspect the filesystem: - -1. Stop the instance. -2. Edit → Change bootscript to `rescue`. -3. Start the instance. -4. Connect via SSH and run: - ```bash - fsck /dev/root - ``` - -## 5. Reattach the Boot Volume - -Sometimes the volume becomes detached. - -Fix: -- Detach and reattach the boot volume in the **Volumes** tab. - -## Still Not Working? - -Contact Scaleway Support with: -- Instance ID -- Screenshot of boot logs -- Steps already tried - -Open a support ticket: https://www.scaleway.com/en/support/ -``` - -```markdown ---- -title: "API/CLI: Create an Instance" -description: Use the Scaleway API or CLI to programmatically create an Instance. ---- - -# API/CLI: Create an Instance - -Automate infrastructure with the Scaleway 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 Credentials - -```bash -scw init -``` - -Follow prompts to enter your **Organization ID** and **API Key**. - -### Create Command - -```bash -scw instance server create \ - image=ubuntu_jammy \ - type=DEV1-S \ - region=fr-par \ - name=my-cli-instance -``` - -### Output - -```bash -ID: 111e89f4-a565-49ea-90da-073255490a67 -IP: 51.159.20.30 -Status: running -``` - -## Using the REST API - -**Endpoint**: -`POST https://api.scaleway.com/instance/v1/zones/fr-par-1/servers` - -**Headers**: -``` -X-Auth-Token: your-api-key -Content-Type: application/json -``` - -**Body**: -```json -{ - "image": "ubuntu_jammy", - "type": "DEV1-S", - "name": "api-instance", - "zone": "fr-par-1" -} -``` - -**Response**: -```json -{ - "server": { - "id": "111e89f4-a565-49ea-90da-073255490a67", - "public_ip": { "address": "51.159.20.30" } - } -} -``` - -## Parameters Reference - -| Parameter | Required | Description | -|---------|--------|------------| -| `image` | Yes | OS image identifier | -| `type` | Yes | Instance size | -| `zone` | Yes | e.g., `fr-par-1` | -| `name` | No | Default: auto-generated | - -## Learn More - -- [CLI Installation Guide](https://www.scaleway.com/en/docs/cli/) -- [API Authentication](https://www.scaleway.com/en/docs/api-reference/#authentication) -``` - -```markdown ---- -title: "Instance Product Overview" -description: Introduction to Scaleway Instances — virtual machines with high performance and flexibility. ---- - -# Instance Product Overview - -Scaleway Instances provide on-demand virtual machines with predictable pricing, high performance, and full control. - -## Key Features - -- Bare-metal and virtual instances -- Multi-region deployment -- Wide range of images -- SSH key management -- Flexible storage - -## Use Cases - -| Use Case | Why Choose Instances | -|--------|----------------------| -| Web Hosting | Full control over environment | -| CI/CD Runner | Isolated, reproducible builds | -| Game Server | Low-latency, high-performance nodes | - -## Getting Started - -Quickstart: -[Create your first instance](/docs/compute/instance/quickstart/) - -Concepts: -[Understand images and bootscripts](/docs/compute/instance/concepts/) - -## Documentation Map - -| Topic | Link | -|------|------| -| How-tos | [All guides](/docs/compute/instance/how-to/) | -| API Reference | [REST & CLI](/docs/compute/instance/api/reference/) | -| Troubleshooting | [Common issues](/docs/compute/instance/troubleshooting/) | -| Changelog | [Release notes](/docs/compute/instance/releases/) | -``` - -```markdown ---- -title: "Release Notes: Instance Updates" -description: Stay up to date with the latest features and fixes for Scaleway Instances. ---- - -# Release Notes: Instance Updates - -## May 2025 - -### New Features -- Added support for `ARM64-128GB` instance type. -- New Ubuntu 24.04 LTS image available. - -### Improvements -- Faster boot times for `GP-S` instances. -- Improved volume detachment handling. - -### Fixes -- Fixed rare crash during live migration. -- Resolved issue with API returning 503 during peak hours. - -## April 2025 - -### New -- New `rescue-buster` bootscript for Debian 10 compatibility. - -### Fixed -- Fixed incorrect disk size display in console. - -All users are automatically updated. No action required. - -Subscribe to updates: -[Email notifications](https://www.scaleway.com/en/support/) | [RSS Feed](https://www.scaleway.com/en/docs/compute/instance/releases/index.xml) -``` \ No newline at end of file From 0853765359263233e7bf18f25c99c2fd570b4c87 Mon Sep 17 00:00:00 2001 From: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> Date: Tue, 18 Nov 2025 16:09:15 +0100 Subject: [PATCH 5/5] feat(gen): more templates --- docs/templates/additional-content.mdx | 0 .../information-about-x-feature.mdx | 13 ++ .../additional-content/limitations.mdx | 10 ++ .../product-features.mdx | 61 ++----- docs/templates/api-cli.mdx | 149 +++++++++--------- docs/templates/concepts.mdx | 24 +++ docs/templates/faq.mdx | 28 ++++ docs/templates/how-tos.mdx | 30 ++-- docs/templates/index.mdx | 69 ++++++++ docs/templates/menu.ts | 76 +++++++++ docs/templates/quickstart.mdx | 56 +++---- docs/templates/troubleshooting.mdx | 35 ++-- 12 files changed, 355 insertions(+), 196 deletions(-) delete mode 100644 docs/templates/additional-content.mdx create mode 100644 docs/templates/additional-content/information-about-x-feature.mdx create mode 100644 docs/templates/additional-content/limitations.mdx rename docs/templates/{ => additional-content}/product-features.mdx (53%) diff --git a/docs/templates/additional-content.mdx b/docs/templates/additional-content.mdx deleted file mode 100644 index e69de29bb2..0000000000 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/product-features.mdx b/docs/templates/additional-content/product-features.mdx similarity index 53% rename from docs/templates/product-features.mdx rename to docs/templates/additional-content/product-features.mdx index d917267dff..8070180813 100644 --- a/docs/templates/product-features.mdx +++ b/docs/templates/additional-content/product-features.mdx @@ -1,11 +1,6 @@ --- title: Information -description: Understand the autohealing feature for PostgreSQL and MySQL databases. -dates: - validation: 2025-04-23 -categories: - - managed-databases - - postgresql-and-mysql +description: Dive deeper into . --- ## Description (Mandatory) @@ -20,6 +15,14 @@ Description of the product including: - 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) @@ -39,45 +42,9 @@ 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: - - ---- -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](#) | -``` +| 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 index 39b16be7ab..0ea8e32b1e 100644 --- a/docs/templates/api-cli.mdx +++ b/docs/templates/api-cli.mdx @@ -1,80 +1,81 @@ --- -title: "API/CLI: Perform an Action" +title: "How to perform an action using the API or the CLI" 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` | - + +- 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 index e69de29bb2..6ddc26e8b6 100644 --- a/docs/templates/concepts.mdx +++ 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 index e69de29bb2..a8f8b3692f 100644 --- a/docs/templates/faq.mdx +++ 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 index 0b8fa7d596..f4f31f5d79 100644 --- a/docs/templates/how-tos.mdx +++ b/docs/templates/how-tos.mdx @@ -1,29 +1,23 @@ --- -title: "How to Perform a Specific Task" +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. +This guide shows how to complete a specific task using the console. -## Requirements + + This page is a template, it gives an **example** display for the content type in question. + -- A running resource of the relevant type. -- Access to the Scaleway Console or CLI. -- Required permissions for the operation. + -## Step 1: Access the Resource +- 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. Log in to the [Scaleway Console](https://console.scaleway.com). -2. Navigate to the service dashboard. -3. Locate and select your resource. +1. Click **Product Name** in the **Product Category** section of the Scaleway console side menu. -## Step 2: Perform the Task +2. Click **Perform task**. A pop-up displays. -1. In the resource interface, locate the relevant section. -2. Click the appropriate button or run the command. -3. Confirm the action. +3. Complete the steps. -Example CLI command: -```bash -scw service:command parameter=value -``` \ No newline at end of file +4. Click **Confirm** to conclude. \ No newline at end of file diff --git a/docs/templates/index.mdx b/docs/templates/index.mdx index e69de29bb2..9e793ac790 100644 --- a/docs/templates/index.mdx +++ 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 index e69de29bb2..ded3288d78 100644 --- a/docs/templates/menu.ts +++ 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 index 118754c2c7..fefb4da49c 100644 --- a/docs/templates/quickstart.mdx +++ b/docs/templates/quickstart.mdx @@ -1,51 +1,39 @@ --- -title: "Quickstart: Set Up a Resource" +title: " Quickstart" description: Get started with the service in a few simple steps. --- -## Quickstart +This guide walks users through creating their first product resource and performing a basic action. -A **Quickstart** helps new users complete a basic task or set up a resource in just a few steps. + + This page is a template, it gives an **example** display for the content type in question. + -### 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 +- 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 -Understood — thank you for the clarification. +## 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. -# Quickstart: Set Up a Resource +3. Complete the following steps in the wizard. -This guide walks you through creating your first resource and performing a basic action. +## How to perform a basic action with the product -## 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. +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. -## Next Steps +## How to delete the product + + + Deleting the product will destroy all the data stored on it. + -- [Learn how to configure advanced settings](#) -- [Explore the API/CLI options](#) -- [Understand core concepts](#) -``` \ No newline at end of file +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 index ef08882adc..2be22ca330 100644 --- a/docs/templates/troubleshooting.mdx +++ b/docs/templates/troubleshooting.mdx @@ -1,13 +1,16 @@ --- -title: "Troubleshooting: Common Issue" +title: "Troubleshooting for 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 + + 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. @@ -18,34 +21,20 @@ A clear statement of the symptom or error message. - Resource in incorrect state - Network or connectivity issue -## Solution 1: Fix the Configuration +## 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 +### 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 -``` \ No newline at end of file + ``` \ No newline at end of file