Skip to content

Commit 1e2aefb

Browse files
authored
docs(fix): replace broken links and update procedures
1 parent ada9c5b commit 1e2aefb

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

pages/guidelines.mdx

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Scaleway Documentation Guidelines
33
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.
44
tags: style-guide guidelines wording grammar
55
dates:
6-
validation: 2025-02-11
6+
validation: 2025-07-23
77
---
88
import Requirements from '@macros/iam/requirements.mdx'
99

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

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).
245245

246246
### Messages
247247

@@ -253,7 +253,7 @@ Three types of message boxes are available, to use as follows:
253253
| 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> |
254254
| 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> |
255255

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).
257257

258258
### Tabs
259259

@@ -299,7 +299,7 @@ Renders as:
299299
</TabsTab>
300300
</Tabs>
301301

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).
303303

304304
## Grammar, syntax and typography
305305

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

419419
### Lightbox component
420420

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:
422422

423423
````
424-
<Lightbox image='scaleway-image-descriptor.webp' alt="description of image" />
424+
import myImage from "./assets/myImage.webp"
425+
426+
<Lightbox image={myImage} alt="Alternative text" />
425427
````
426428

427429
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:
460462
```
461463

462464
- **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).
465466
- **tags**: The tags used by internal and external search engines to help users find the page
466467
- **dates: posted**: The date the page was originally created, in the format `yyyy-mm-dd`. This displays on the generated page.
467468
- **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
488489
### Requirements
489490

490491
---
492+
import Requirements from '@macros/iam/requirements.mdx'
493+
491494
<Requirements />
492495

493496
- 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
497500
- Installed `helm` (version 3.2+), the Kubernetes [packet manager](https://helm.sh/), on your local machine
498501
---
499502

500-
Start by using the macro `<Requirements />` or type the macro text manually. For example:
503+
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:
501504

502505
| Macro id | Text formatting |
503506
|-------------------------------|-----------------|
@@ -518,4 +521,4 @@ Continue by listing the necessary products, resources or items users must have.
518521
|`- An [SSH key](/organizations-and-projects/how-to/create-ssh-key/)` | - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) |
519522
|`- A valid [API key](/iam/how-to/create-api-keys/)` | - A valid [API key](/iam/how-to/create-api-keys/) |
520523
|`- 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

Comments
 (0)