Skip to content

Commit a067b97

Browse files
authored
fix(guidelines): add for urls (#5578)
1 parent 282d801 commit a067b97

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

pages/guidelines.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,20 @@ When creating an entirely new documentation page from scratch, we generally expe
8080

8181
All Scaleway documentation pages should be `.mdx` files (MDX is an extension to Markdown that lets you include JSX). Any images included within the page must be `.webp` files.
8282

83+
### Page URL
84+
85+
All Scaleway product documentation pages have URLs that should conform to the following format:
86+
87+
`https://www.scaleway.com/en/docs/<product-name>/<page-type>/<page-slug>/`
88+
89+
| URL element | Description | Guidance |
90+
|-------------|-------------|----------|
91+
| Product name | Scaleway documentation and developers sites use the **full product name** in their URLs. | ✅ managed-databases-for-redis, container-registry <br/><br/>❌ redis, registry |
92+
| Page type | All product documentation pages should conform to one of the [page types listed above](#page-type) | E.g. `how-to`, `api-cli`, `concepts`. |
93+
| Page slug | A short, descriptive, slug, usually based on the title of the page. To keep slugs short, you can omit the product name<br/>(already in the URL at a higher level) and stopwords. Note that certain page types (concepts, quickstart etc.) do not have further page slugs and terminate at type.| ✅ manage-flexible-ips, create-pipeline <br/><br/>❌ manage-your-instance-flexible-ips, create-an-edge-services-pipeline |
94+
95+
Note that for [tutorials](/tutorials/), the URL format is: `https://www.scaleway.com/en/docs/tutorials/<page-slug>/`, and it is pertinent to include the relevant product name in the page slug, as it does not appear elsewhere in the URL.
96+
8397
### Page structure
8498

8599
Scaleway Documentation pages should conform to the following structure:

0 commit comments

Comments
 (0)