Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions pages/guidelines.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Scaleway Documentation Guidelines
description: Discover comprehensive guidelines on writing and formatting for our documentation site. Ensure consistency and clarity with our style guide, covering grammar, terminology, and best practices.
tags: style-guide guidelines wording grammar
dates:
validation: 2025-02-11
validation: 2025-07-23
---
import Requirements from '@macros/iam/requirements.mdx'

Expand Down Expand Up @@ -241,7 +241,7 @@ Use a console icon when referring in the documentation to the equivalent icon in
| ------------------------------------------------------------------- | ---------------------------------------------------------- |
| ````Use the toggle <Icon name="toggle" /> to activate the feature```` | Use the toggle <Icon name="toggle" /> to activate the feature |

See the [full list of available icons](/components/docs/#inline-console-icons).
See the [full list of available icons](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-icon--docs).

### Messages

Expand All @@ -253,7 +253,7 @@ Three types of message boxes are available, to use as follows:
| Tip | Information about a different way to accomplish something, or how to go further | ````<Message type="tip"> </Message>```` | <Message type="tip"> This is a tip </Message> |
| Important | Critical warnings and information that the user must read to avoid unwanted consequences or mistakes | ````<Message type="important"> </Message>```` | <Message type="important"> This is important </Message> |

Read more about [message box components](/components/docs/#messages).
Read more about [message box components](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-message--docs).

### Tabs

Expand Down Expand Up @@ -299,7 +299,7 @@ Renders as:
</TabsTab>
</Tabs>

Read more about the [tab component](/components/docs/#tabs).
Read more about the [tab component](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-tabs--docs).

## Grammar, syntax and typography

Expand Down Expand Up @@ -418,10 +418,12 @@ A wording handbook is available internally, with a full list of correct product

### Lightbox component

Use the [Lightbox component](/components/docs/#lightbox) for images, with the following syntax:
Use the [Lightbox component](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-lightbox--docs) for images, with the following syntax:

````
<Lightbox image='scaleway-image-descriptor.webp' alt="description of image" />
import myImage from "./assets/myImage.webp"

<Lightbox image={myImage} alt="Alternative text" />
````

All images must be in `webp` format, and stored in the page's `assets` folder. Image names must always start with `scaleway`, and the words should be hyphen-seperated.
Expand Down Expand Up @@ -460,8 +462,7 @@ categories:
```

- **title**: The title of the page, used by external search engines and the main title that displays on the documentation page.
- **description**: The description, used by external search engines. It should be between 120 and 160 characters, and SEO-optimized, using clear, engaging language suitable for a wide audience. Also displays on some
documentation pages (e.g. when the page is linked to from a [product card](https://www.scaleway.com/en/docs/components/docs-editor/#productcard)).
- **description**: The description, used by external search engines. It should be between 120 and 160 characters, and SEO-optimized, using clear, engaging language suitable for a wide audience. Also displays on some documentation pages (e.g. when the page is linked to from a [product card](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-card--docs).
- **tags**: The tags used by internal and external search engines to help users find the page
- **dates: posted**: The date the page was originally created, in the format `yyyy-mm-dd`. This displays on the generated page.
- **dates: validation**: The date the page was last validated, in the format `yyyy-mm-dd`. This displays on the generated page, and is used by the Documentation team when identifying documentation pages that need reviewing.
Expand All @@ -488,6 +489,8 @@ The introduction should be a few sentences, or a few short paragraphs, which exp
### Requirements

---
import Requirements from '@macros/iam/requirements.mdx'

<Requirements />

- A Scaleway account logged into the [console](https://console.scaleway.com)
Expand All @@ -497,7 +500,7 @@ The introduction should be a few sentences, or a few short paragraphs, which exp
- Installed `helm` (version 3.2+), the Kubernetes [packet manager](https://helm.sh/), on your local machine
---

Start by using the macro `<Requirements />` or type the macro text manually. For example:
Import the `<Requirements />` macro under the page's [metadata](#metadata) as shown in the example above, then use the macro or type the macro text manually. For example:

| Macro id | Text formatting |
|-------------------------------|-----------------|
Expand All @@ -518,4 +521,4 @@ Continue by listing the necessary products, resources or items users must have.
|`- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)` | - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) |
|`- A valid [API key](/iam/how-to/create-api-keys/)` | - A valid [API key](/iam/how-to/create-api-keys/) |
|`- Downloaded and installed the [Scaleway CLI](https://github.com/scaleway/scaleway-cli#scaleway-cli-v2) ` | - Downloaded and installed the [Scaleway CLI](https://github.com/scaleway/scaleway-cli#scaleway-cli-v2) |
|`- An [Instance](/instances/how-to/create-an-instance) ` | - An [Instance](/instances/how-to/create-an-instance) |
|`- An [Instance](/instances/how-to/create-an-instance) ` | - An [Instance](/instances/how-to/create-an-instance) |