You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
|````Use the toggle <Icon name="toggle" /> to activate the feature````| Use the toggle <Iconname="toggle" /> to activate the feature |
243
243
244
-
See the [full list of available icons](/components/docs/#inline-console-icons).
244
+
See the [full list of available icons](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-icon--docs).
245
245
246
246
### Messages
247
247
@@ -253,7 +253,7 @@ Three types of message boxes are available, to use as follows:
253
253
| Tip | Information about a different way to accomplish something, or how to go further |````<Message type="tip"> </Message>````| <Messagetype="tip"> This is a tip </Message> |
254
254
| Important | Critical warnings and information that the user must read to avoid unwanted consequences or mistakes |````<Message type="important"> </Message>````| <Messagetype="important"> This is important </Message> |
255
255
256
-
Read more about [message box components](/components/docs/#messages).
256
+
Read more about [message box components](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-message--docs).
257
257
258
258
### Tabs
259
259
@@ -299,7 +299,7 @@ Renders as:
299
299
</TabsTab>
300
300
</Tabs>
301
301
302
-
Read more about the [tab component](/components/docs/#tabs).
302
+
Read more about the [tab component](https://docs-sb-storybook-staging.s3-website.fr-par.scw.cloud/?path=/docs/mdx-tabs--docs).
303
303
304
304
## Grammar, syntax and typography
305
305
@@ -418,10 +418,12 @@ A wording handbook is available internally, with a full list of correct product
418
418
419
419
### Lightbox component
420
420
421
-
Use the [Lightbox component](/components/docs/#lightbox) for images, with the following syntax:
421
+
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:
422
422
423
423
````
424
-
<Lightbox image='scaleway-image-descriptor.webp' alt="description of image" />
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.
@@ -460,8 +462,7 @@ categories:
460
462
```
461
463
462
464
-**title**: The title of the page, used by external search engines and the main title that displays on the documentation page.
463
-
-**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
464
-
documentation pages (e.g. when the page is linked to from a [product card](https://www.scaleway.com/en/docs/components/docs-editor/#productcard)).
465
+
-**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).
465
466
-**tags**: The tags used by internal and external search engines to help users find the page
466
467
-**dates: posted**: The date the page was originally created, in the format `yyyy-mm-dd`. This displays on the generated page.
467
468
-**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.
@@ -488,6 +489,8 @@ The introduction should be a few sentences, or a few short paragraphs, which exp
- A Scaleway account logged into the [console](https://console.scaleway.com)
@@ -497,7 +500,7 @@ The introduction should be a few sentences, or a few short paragraphs, which exp
497
500
- Installed `helm` (version 3.2+), the Kubernetes [packet manager](https://helm.sh/), on your local machine
498
501
---
499
502
500
-
Start by using the macro `<Requirements />` or type the macro text manually. For example:
503
+
Importthe`<Requirements />`macrounderthepage's [metadata](#metadata) as shown in the example above, then use the macro or type the macro text manually. For example:
@@ -518,4 +521,4 @@ Continue by listing the necessary products, resources or items users must have.
518
521
|`- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)`| - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)|
519
522
|`- A valid [API key](/iam/how-to/create-api-keys/)`| - A valid [API key](/iam/how-to/create-api-keys/)|
520
523
|`- 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)|
521
-
|`- An [Instance](/instances/how-to/create-an-instance) `| - An [Instance](/instances/how-to/create-an-instance)|
524
+
|`- An [Instance](/instances/how-to/create-an-instance) `| - An [Instance](/instances/how-to/create-an-instance)|
0 commit comments