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
@@ -21,11 +21,11 @@ Anyone who has a GitHub account can contribute to the documentation content:
21
21
- You have a [GitHub](https://github.com/signup) personal account
22
22
- You have installed [yarn](https://yarnpkg.com/getting-started) package manager
23
23
- You have [Markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) and [MDX](https://mdxjs.com/guides/) syntax knowledge
24
-
- You have read [the writing guidelines](#writing-guidelines)
24
+
- You have read [the writing guidelines](https://www.scaleway.com/en/docs/guidelines/)
25
25
26
26
### Contribution procedure for internal Scaleway users
27
27
28
-
:warning:**Important**
28
+
:warning:**Important**
29
29
- All rules below concern this repository.
30
30
- Any PRs which do not comply with the rules below will be rejected.
31
31
@@ -41,10 +41,10 @@ Anyone who has a GitHub account can contribute to the documentation content:
41
41
42
42
-`product`: the name of the product that corresponds to the documentation page you will edit.
43
43
44
-
:information_source:**Example:**
44
+
:information_source:**Example:**
45
45
in the branch `int-add-instances`, an internal contributor will add information to a documentation page of the Instances product category.
46
46
47
-
4. Make your edits to the documentation. Refer to the [writing guidelines](#writing-guidelines) below to ensure your changes comply with our style guide.
47
+
4. Make your edits to the documentation. Refer to the [writing guidelines](https://www.scaleway.com/en/docs/guidelines/) to ensure your changes comply with our style guide.
48
48
49
49
5. Run `git commit -m "type(module): description with some words <BRANCH_NAME>"`. Refer to the [commit naming conventions](#commit-conventions) below to properly name your commit.
50
50
@@ -53,14 +53,14 @@ Anyone who has a GitHub account can contribute to the documentation content:
53
53
All PR names must comply with the following naming convention: `docs($PRODUCTNAME): $FIXEXPLANATION BRANCHNAME`.
54
54
55
55
56
-
:warning:**Important**
56
+
:warning:**Important**
57
57
All PRs are reviewed and approved by the Scaleway Product Documentation team before being merged by them.
58
58
59
59
---
60
60
61
61
### Contribution procedure for external users
62
62
63
-
:warning:**Important**
63
+
:warning:**Important**
64
64
- All rules below concern this repository.
65
65
- Any PRs which do not comply with the rules below will be rejected.
66
66
@@ -78,10 +78,10 @@ Anyone who has a GitHub account can contribute to the documentation content:
78
78
79
79
-`product`: the name of the product that corresponds to the documentation page you will edit.
80
80
81
-
:information_source:**Example:**
81
+
:information_source:**Example:**
82
82
in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category.
83
83
84
-
4. Make your edits to the documentation. Refer to the [writing guidelines](#writing-guidelines) below to ensure your changes comply with our guidelines.
84
+
4. Make your edits to the documentation. Refer to the [writing guidelines](https://www.scaleway.com/en/docs/guidelines/) to ensure your changes comply with our guidelines.
85
85
86
86
5. Run `git commit -m "type(module): description of what you performed <BRANCH_NAME>"`. Refer to the [commit naming conventions](#commit-conventions) below to properly name your commit.
87
87
@@ -101,7 +101,7 @@ Anyone who has a GitHub account can contribute to the documentation content:
101
101
102
102
All pull requests names must comply with the following naming convention: `docs(<PRODUCT_NAME>): <ACTION> <EXPLANATION> <BRANCH_NAME>`.
103
103
104
-
:warning:**Important**
104
+
:warning:**Important**
105
105
All pull requests are reviewed and approved by the Scaleway Product Documentation team before being merged by them.
106
106
107
107
---
@@ -188,7 +188,7 @@ Feel free to explore this page in your markdown editor to see how the components
188
188
189
189
### Frontmatter
190
190
191
-
Any Markdown file that contains a YAML frontmatter block will be processed by Gatsby as a special file.
191
+
Any Markdown file that contains a YAML frontmatter block will be processed by Gatsby as a special file.
192
192
The front matter must be the first thing in the file and must take the form of a valid YAML set between triple-dashed lines.
193
193
194
194
Here is a common example used in our `.mdx` files:
@@ -221,131 +221,4 @@ Here starts the content…
221
221
222
222
## Writing Guidelines
223
223
224
-
### Requirements
225
-
226
-
In this section, point out what the user must have already prepared before starting the step-by-step. Include links to other documentation pages.
227
-
228
-
Example:
229
-
230
-
---
231
-
232
-
**Requirements**
233
-
234
-
- You have a Scaleway Account
235
-
- You have configured your SSH key
236
-
237
-
---
238
-
239
-
See also: [Message boxes typographical conventions](#message-boxes)
240
-
241
-
### Titles/Anchors
242
-
243
-
You can go up to 5 hierarchy levels (H1, H2, H3, H4, H5).
244
-
245
-
---
246
-
247
-
**Important**
248
-
249
-
- In the right menu, **only H1 and H2 are visible**.
250
-
251
-
-**No titles should be orphaned**. For example, if you started with H2, you should go down in sequence. So the next step should either be another H2 or a level lower (in this case, H3).
252
-
253
-
---
254
-
255
-
See also: [Anchors and titles components](/components#h2-title)
256
-
257
-
## Typographical Conventions
258
-
259
-
### Spelling
260
-
261
-
At Scaleway we use US English.
262
-
263
-
### Capitalization
264
-
265
-
What should be capitalized:
266
-
267
-
- Product names
268
-
269
-
### Emboldening
270
-
271
-
Bold text is used to represent where a user should click or highlight other text relevant to the UI.
272
-
273
-
Example:
274
-
275
-
Click **+ Create an Instance to proceed.**
276
-
277
-
## Code Snippets
278
-
279
-
Use a code block for examples of:
280
-
281
-
- commands
282
-
- scripts
283
-
- outputs
284
-
285
-
Use inline code when you need to reference information in your text, such as:
286
-
287
-
- environment variables
288
-
- e-mail addresses
289
-
- referencing parts of the code block in the text
290
-
291
-
### Message boxes
292
-
293
-
Message boxes help you highlight important or pertinent information.
294
-
295
-
**Tip**: An alternative way of doing the step, or links to additional information about the step.
296
-
297
-
**Note**: Information about the consequence(s) of a step.
298
-
299
-
**Important**: Warning about a possible unwanted consequence (eg delete all data) or possible mistake that could be made during this step.
300
-
301
-
**Requirements**: A list of what the user must have already prepared before starting the step-by-step.
302
-
303
-
See also: [Message box components](/components#messages)
304
-
305
-
### Environment Variables
306
-
307
-
When referring to API calls or CLI commands, follow the environment variable conventions listed on [this page](https://github.com/scaleway/scaleway-sdk-go/tree/master/scw#environment-variables). Use the same format for other variables.
308
-
309
-
Example:
310
-
311
-
```
312
-
$EMAIL_ADDRESS
313
-
```
314
-
315
-
If you need to use an example of IP addresses, some IP ranges are reserved for documentation:
316
-
317
-
**IPv4**
318
-
319
-
192.0.2.0/24
320
-
321
-
198.51.100.0/24
322
-
323
-
203.0.113.0/24
324
-
325
-
233.252.0.0/24
326
-
327
-
**IPv6**
328
-
329
-
2001:db8::/32
330
-
331
-
## Screenshot Guidelines
332
-
333
-
### Format
334
-
335
-
Save screenshots in `.png` format.
336
-
337
-
### Information to omit
338
-
339
-
Omit any personal information (such as e-mail addresses, addresses, telephone numbers, the Scaleway resource ID, etc). Use the blur effect over the information you wish to conceal.
340
-
341
-
### Captions
342
-
343
-
If the image contents are already being described in the documentation text, there is no need to include a caption. To increase accessibility, if new information is being presented in the image, include a description (`alt="caption"`).
344
-
345
-
### Image Names
346
-
347
-
Start with “Scaleway” and make the name as explicit as possible, describing the screenshot.
348
-
349
-
Example:
350
-
351
-
`scaleway-top-right-menu.png` or `scaleway-leave-organization`
224
+
Refer to the [Scaleway Documentation Guidelines](https://www.scaleway.com/en/docs/guidelines/) for an extensive list of our writing guidelines.
0 commit comments