Skip to content

Commit 8cbdbe9

Browse files
iManunerda-codes
andauthored
docs: update contribution frontmatter - WDOC-1102 (#5274)
* docs(sem): add secret deletion (#4851) * docs: update contribution frontmatter - WDOC-1102 --------- Co-authored-by: Néda <[email protected]>
1 parent c8d45cb commit 8cbdbe9

File tree

5 files changed

+37
-50
lines changed

5 files changed

+37
-50
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -195,28 +195,21 @@ Here is a common example used in our `.mdx` files:
195195

196196
```markdown
197197
---
198-
meta:
199-
title: How to create a Bare Metal server
200-
description: This page explains how to create a Bare Metal server
201-
content:
202-
h1: Bare Metal server
203-
paragraph: This is a tutorial Bare Metal
204-
hero: assets/scaleway-account.png
198+
title: How to create a Bare Metal server
199+
description: This page explains how to create a Bare Metal server
205200
tags: compute baremetal bare metal cloud server dedicated
206201
dates:
207202
validation: 2021-06-22
208203
posted: 2020-03-12
204+
categories:
205+
- compute
209206
---
210207

211208
Here starts the content…
212209
```
213210

214-
- `meta` part is used for SEO `title` and `description`, it doesn't appear inside the website
215-
- `content` part which contains `h1` and `paragraph` is used for title and description inside website pages.
216-
- `h1` is used as H1 in pages, in the HTML head element as the browser tab title and for SEO.
217-
- `paragraph` is used in pages and in the head element for SEO.
218-
- `image` is used for the hero section image in tutorial pages. The image path can be relative to the file.
219-
- `tags` are used to help populate search result lists or pages top.
211+
- `title` and `description`, used for SEO, Algolia & for h1 and description in pages
212+
- `tags` are used to help populate search result lists or pages top. Use space separators.
220213
- `dates` are shown on pages under titles. `validation` must be a date later than the `posted`. Its format should be `AAAA-MM-DD`.
221214

222215
## Writing Guidelines

docs/DOC_PAGE_TEMPLATE.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: # Title of the page
33
description: # One-sentence description of the page.
4-
tags: # enter tags here
5-
# dates:
4+
tags: # enter tags here, use space as separator
5+
dates:
66
# validation: XXXX-XX-XX (Year-Month-Day format)
77
# posted: XXXX-XX-XX (Year-Month-Day format)
88
categories:

docs/TROUBLESHOOTING_TEMPLATE.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
meta:
32
title: Title describing the PROBLEM (I cannot..., I am experiencing..., My resource..., I am unable to..., Resource not found, etc.)
43
description: Description for SEO and referencing purposes that complements the title
54
tags: fail error troubleshooting help unable cannot

pages/contribute.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Scaleway Write for the Community program
33
description: This page explains how to participate in the Scaleway Write for the Community program.
44
tags: write-for-the-community community contribute git voucher
5-
cta: false
65
---
76

87
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.

pages/guidelines.mdx

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ If you are creating a new page, it may be easiest to duplicate an existing page
9595

9696
More information about the different sections of each page can be found by following the links in the table above.
9797

98-
## Page content
98+
## Page content
9999

100100
### Headers
101101

102102
- There can be only one H1 on each page (the page title, defined in the [metadata](#metadata))
103103
- 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.
104104
- 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).
106106
- All headers should be in [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case). Product names should nonetheless be capitalized as appropriate.
107107

108108
### Numbered steps
@@ -154,28 +154,28 @@ Markdown syntax:
154154
````
155155
```python
156156
my_list=[1,6,9,4]
157-
my_list[1]=3
157+
my_list[1]=3
158158
print(my_list)
159159
```
160-
````
160+
````
161161

162162
Renders as:
163163

164164
```python
165165
my_list=[1,6,9,4]
166-
my_list[1]=3
166+
my_list[1]=3
167167
print(my_list)
168168
```
169169

170170
### Inline code
171171

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.
173173

174174
Markdown syntax (backticks):
175175

176176
````
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+
````
179179

180180
Renders as:
181181

@@ -221,14 +221,14 @@ When linking to an external page, copy and paste the full link exactly as it app
221221

222222
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` ````.
223223

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

226226
````
227227
```php
228228
<?php
229229
more code here
230230
?>
231-
231+
232232
To go to the next page <A HREF="URLexample/nextpage.php">click here</A>
233233
```
234234
````
@@ -240,7 +240,7 @@ Use a console icon when referring in the documentation to the equivalent icon in
240240
| Syntax | Renders as |
241241
| ------------------------------------------------------------------- | ---------------------------------------------------------- |
242242
| ````Use the toggle <Icon name="toggle" /> to activate the feature```` | Use the toggle <Icon name="toggle" /> to activate the feature |
243-
243+
244244
See the [full list of available icons](/components/docs/#inline-console-icons).
245245

246246
### Messages
@@ -249,7 +249,7 @@ Three types of message boxes are available, to use as follows:
249249

250250
| Message type | Use for | Syntax | Renders as |
251251
|--------------|------------------------|--------|------------|
252-
| Note | Extra information that may not be relevant in all cases or to all users | ````<Message type="note"> </Message>```` | <Message type="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>```` | <Message type="note"> This is a note </Message> |
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

@@ -269,15 +269,15 @@ Tabs syntax:
269269

270270
```
271271
<Tabs id="example-tabs">
272-
272+
273273
<TabsTab label="Tab one">
274274
This is the content of tab one
275275
</TabsTab>
276-
276+
277277
<TabsTab label="Tab two">
278278
This is the content of tab two
279279
</TabsTab>
280-
280+
281281
<TabsTab label="Tab three">
282282
This is the content of tab three
283283
</TabsTab>
@@ -305,7 +305,7 @@ Read more about the [tab component](/components/docs/#tabs).
305305

306306
### Pronouns
307307

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".
309309

310310
| ✅ DO WRITE | ❌ DO NOT WRITE |
311311
| ------------------------------------------ | ----------------------------------------------- |
@@ -336,7 +336,7 @@ Always use "click", not "click on"
336336

337337
### Commas
338338

339-
Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known as the serial comma).
339+
Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known as the serial comma).
340340

341341
| ✅ DO WRITE | ❌ DO NOT WRITE |
342342
| ------------------------------------------ | ----------------------------------------------- |
@@ -373,13 +373,13 @@ Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known a
373373
### Dates and times
374374

375375
- 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`.
377377
- 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).
378378

379379
### Bits and bytes
380380

381381
- Add a space between the bits/bytes abbreviation and the number, e.g. `100 MB`, `1 Gbps`
382-
- Use the following abbreviations:
382+
- Use the following abbreviations:
383383

384384
| Term | Abbreviation | Example |
385385
| --------------------- | ------------------|----------------------------------------- |
@@ -405,8 +405,8 @@ When referring to different aspects of the Scaleway console, use the following t
405405
| Side menu | <Lightbox image={image2} alt="" /> |
406406
| Organization drop-down menu | <Lightbox image={image3} alt="" /> |
407407
| $PRODUCT_NAME dashboard, e.g. Object Storage dashboard | <Lightbox image={image4} alt="" /> |
408-
| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | <Lightbox image={image5} alt="" /> |
409-
| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | <Lightbox image={image6} alt="" /> |
408+
| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | <Lightbox image={image5} alt="" /> |
409+
| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | <Lightbox image={image6} alt="" /> |
410410

411411
### Product and feature names
412412

@@ -448,12 +448,8 @@ Diagrams and schemas should be produced in accordance with Scaleway visual desig
448448

449449
```
450450
---
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.
457453
tags: instance create
458454
dates:
459455
validation: 2024-06-10
@@ -463,16 +459,16 @@ categories:
463459
---
464460
```
465461

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
470466
- **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.
472468
- **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.
473469

474470
<Message type="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:
476472
- **How to**: How to + infinitve verb + 5 words maximum
477473
- **Tutorial**: Start with a gerund, e.g. "Deploying WordPress with LEMP on Ubuntu Focal Fossa"
478474
- **Troubleshooting**: The title should describe the problem, e.g. "Auto-configuration is not working"

0 commit comments

Comments
 (0)