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
Copy file name to clipboardExpand all lines: pages/contribute.mdx
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,6 @@
2
2
title: Scaleway Write for the Community program
3
3
description: This page explains how to participate in the Scaleway Write for the Community program.
4
4
tags: write-for-the-community community contribute git voucher
5
-
cta: false
6
5
---
7
6
8
7
Join the Scaleway **Write for the Community** program, an initiative for making our [open-source Documentation](https://github.com/scaleway/docs-content/) a truly collaborative knowledge center.
Copy file name to clipboardExpand all lines: pages/guidelines.mdx
+29-33Lines changed: 29 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,14 +95,14 @@ If you are creating a new page, it may be easiest to duplicate an existing page
95
95
96
96
More information about the different sections of each page can be found by following the links in the table above.
97
97
98
-
## Page content
98
+
## Page content
99
99
100
100
### Headers
101
101
102
102
- There can be only one H1 on each page (the page title, defined in the [metadata](#metadata))
103
103
- Use H2s (e.g. `## My subtitle`) to divide the page into subsections, and H3s (e.g. `### My sub-subtitle`) to divide the subsections (if appropriate). You can go up to 5 hierarchy levels (H5). In the right "Jump-to" menu, only H2s and H3s are visible and clickable.
104
104
- Headers also serve as anchors. Link to a header anchor as follows `[text to display](#header-with-spaces-replaced-by-dashes)`
105
-
- No headers should be orphaned. If you begin with H2, go down in sequence. The next step should either be another H2 or a level lower (in this case, H3).
105
+
- No headers should be orphaned. If you begin with H2, go down in sequence. The next step should either be another H2 or a level lower (in this case, H3).
106
106
- All headers should be in [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case). Product names should nonetheless be capitalized as appropriate.
107
107
108
108
### Numbered steps
@@ -154,28 +154,28 @@ Markdown syntax:
154
154
````
155
155
```python
156
156
my_list=[1,6,9,4]
157
-
my_list[1]=3
157
+
my_list[1]=3
158
158
print(my_list)
159
159
```
160
-
````
160
+
````
161
161
162
162
Renders as:
163
163
164
164
```python
165
165
my_list=[1,6,9,4]
166
-
my_list[1]=3
166
+
my_list[1]=3
167
167
print(my_list)
168
168
```
169
169
170
170
### Inline code
171
171
172
-
Use inline code to reference information in your text, such as environment variables, placeholder values, and single-line short code snippets.
172
+
Use inline code to reference information in your text, such as environment variables, placeholder values, and single-line short code snippets.
173
173
174
174
Markdown syntax (backticks):
175
175
176
176
````
177
-
Do not forget to replace `<YOUR INSTANCE NAME>` with the name of your Instance.
178
-
````
177
+
Do not forget to replace `<YOUR INSTANCE NAME>` with the name of your Instance.
178
+
````
179
179
180
180
Renders as:
181
181
@@ -221,14 +221,14 @@ When linking to an external page, copy and paste the full link exactly as it app
221
221
222
222
When writing a "fake" or example link that does not lead to a real page, put it in inline code by using backticks: ```` `www/example-link.com` ````.
223
223
224
-
When including a "fake" or example link in a code box with an `<a href>` tag or similar, include the keyword `URLexample` in the URL:
224
+
When including a "fake" or example link in a code box with an `<a href>` tag or similar, include the keyword `URLexample` in the URL:
225
225
226
226
````
227
227
```php
228
228
<?php
229
229
more code here
230
230
?>
231
-
231
+
232
232
To go to the next page <A HREF="URLexample/nextpage.php">click here</A>
233
233
```
234
234
````
@@ -240,7 +240,7 @@ Use a console icon when referring in the documentation to the equivalent icon in
| Note | Extra information that may not be relevant in all cases or to all users |````<Message type="note"> </Message>````| <Messagetype="note"> This is a note </Message> |
252
+
| Note | Extra information that may not be relevant in all cases or to all users |````<Message type="note"> </Message>````| <Messagetype="note"> This is a note </Message> |
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
@@ -269,15 +269,15 @@ Tabs syntax:
269
269
270
270
```
271
271
<Tabs id="example-tabs">
272
-
272
+
273
273
<TabsTab label="Tab one">
274
274
This is the content of tab one
275
275
</TabsTab>
276
-
276
+
277
277
<TabsTab label="Tab two">
278
278
This is the content of tab two
279
279
</TabsTab>
280
-
280
+
281
281
<TabsTab label="Tab three">
282
282
This is the content of tab three
283
283
</TabsTab>
@@ -305,7 +305,7 @@ Read more about the [tab component](/components/docs/#tabs).
305
305
306
306
### Pronouns
307
307
308
-
When addressing the user, say "you". When referring to Scaleway, say "Scaleway", "it", or "we".
308
+
When addressing the user, say "you". When referring to Scaleway, say "Scaleway", "it", or "we".
@@ -373,13 +373,13 @@ Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known a
373
373
### Dates and times
374
374
375
375
- For times, use the 24-hour format. If it is necessary to use the 12-hour format, use `a.m.` or `p.m.` appropriately
376
-
- For dates, use `day/month/year` or `DD/MM/YY`.
376
+
- For dates, use `day/month/year` or `DD/MM/YY`.
377
377
- You can also write out the date, e.g. ` 14 January 2022`. Avoid ordinals, e.g. `14th January`. For a full list of allowed date formats, see the [UX writing guide](https://ultraviolet.scaleway.com/6dd9b5c45/p/45cfa5-date-and-time/b/210929).
378
378
379
379
### Bits and bytes
380
380
381
381
- Add a space between the bits/bytes abbreviation and the number, e.g. `100 MB`, `1 Gbps`
@@ -448,12 +448,8 @@ Diagrams and schemas should be produced in accordance with Scaleway visual desig
448
448
449
449
```
450
450
---
451
-
meta:
452
-
title: How to create an Instance
453
-
description: Learn how to create a cloud instance with Scaleway in simple steps. Follow this guide to efficiently set up and manage your compute resources.
454
-
content:
455
-
h1: How to create an Instance
456
-
paragraph: Learn how to create a cloud instance with Scaleway in simple steps. Follow this guide to efficiently set up and manage your compute resources.
451
+
title: How to create an Instance
452
+
description: Learn how to create a cloud instance with Scaleway in simple steps. Follow this guide to efficiently set up and manage your compute resources.
457
453
tags: instance create
458
454
dates:
459
455
validation: 2024-06-10
@@ -463,16 +459,16 @@ categories:
463
459
---
464
460
```
465
461
466
-
-**meta: title** and **meta: description**: The title and description of the page, used by external search engines when indexing and displaying results. The description should be between 120 and 160 characters, and SEO-optimized, using clear, engaging language suitable for a wide audience.
467
-
-**content: h1**: The main title that displays on the documentation page.
468
-
-**content: paragraph**: The description that 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).
469
-
-**tags**: The tags used by internal and external search engines to help users find the page
462
+
-**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
+
-**tags**: The tags used by internal and external search engines to help users find the page
470
466
-**dates: posted**: The date the page was originally created, in the format `yyyy-mm-dd`. This displays on the generated page.
471
-
-**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.
467
+
-**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.
472
468
-**categories**: The overall product [category](https://github.com/scaleway/docs-content/blob/main/menu/filters.json) that the documentation fits into, used by the site's internal Algolia search.
473
469
474
470
<Messagetype="note">
475
-
The `meta: title` and `content: title` should be the same, other than in exceptional cases. Titles should be in [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case). Different page types should have different types of titles:
471
+
Titles should be in [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case). Different page types should have different types of titles:
476
472
-**How to**: How to + infinitve verb + 5 words maximum
477
473
-**Tutorial**: Start with a gerund, e.g. "Deploying WordPress with LEMP on Ubuntu Focal Fossa"
478
474
-**Troubleshooting**: The title should describe the problem, e.g. "Auto-configuration is not working"
0 commit comments