docs: update contribution frontmatter - WDOC-1102

iManu · iManu · commit efc2ce7db1bf · 2025-07-15T13:48:59.000+02:00
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -195,28 +195,21 @@ Here is a common example used in our `.mdx` files:
 
 ```markdown
 ---
-meta:
-  title: How to create a Bare Metal server
-  description: This page explains how to create a Bare Metal server
-content:
-  h1: Bare Metal server
-  paragraph: This is a tutorial Bare Metal
-hero: assets/scaleway-account.png
+title: How to create a Bare Metal server
+description: This page explains how to create a Bare Metal server
 tags: compute baremetal bare metal cloud server dedicated
 dates:
   validation: 2021-06-22
   posted: 2020-03-12
+categories:
+  - compute
 ---
 
 Here starts the content…
 ```
 
-- `meta` part is used for SEO `title` and `description`, it doesn't appear inside the website
-- `content` part which contains `h1` and `paragraph` is used for title and description inside website pages.
-- `h1` is used as H1 in pages, in the HTML head element as the browser tab title and for SEO.
-- `paragraph` is used in pages and in the head element for SEO.
-- `image` is used for the hero section image in tutorial pages. The image path can be relative to the file.
-- `tags` are used to help populate search result lists or pages top.
+- `title` and `description`, used for SEO, Algolia & for h1 and description in pages
+- `tags` are used to help populate search result lists or pages top. Use space separators.
 - `dates` are shown on pages under titles. `validation` must be a date later than the `posted`. Its format should be `AAAA-MM-DD`.
 
 ## Writing Guidelines
diff --git a/docs/DOC_PAGE_TEMPLATE.mdx b/docs/DOC_PAGE_TEMPLATE.mdx
@@ -1,12 +1,8 @@
 ---
-meta:
-  title: # Title of the page
-  description: # One-sentence description of the page.
-content:
-  h1: # Title of the page again
-  paragraph: # One-sentence description of the page.
-tags: # enter tags here
-# dates:
+title: # Title of the page
+description: # One-sentence description of the page.
+tags: # enter tags here, use space as separator
+dates:
   # validation: XXXX-XX-XX (Year-Month-Day format)
   # posted: XXXX-XX-XX (Year-Month-Day format)
 categories:
diff --git a/docs/TROUBLESHOOTING_TEMPLATE.mdx b/docs/TROUBLESHOOTING_TEMPLATE.mdx
@@ -1,10 +1,6 @@
 ---
-meta: 
-  title: Title describing the PROBLEM (I cannot..., I am experiencing..., My resource..., I am unable to..., Resource not found, etc.)
-  description: Description for SEO and referencing purposes that complements the title
-content:
-  h1: Title describing the PROBLEM (I cannot..., I am experiencing..., My resource..., I am unable to..., Resource not found, etc.)
-  paragraph: Description for SEO and referencing purposes that complements the title
+title: Title describing the PROBLEM (I cannot..., I am experiencing..., My resource..., I am unable to..., Resource not found, etc.)
+description: Description for SEO and referencing purposes that complements the title
 tags: fail error troubleshooting help unable cannot
 dates:
   validation: 2025-03-10
diff --git a/pages/contribute.mdx b/pages/contribute.mdx
@@ -1,12 +1,7 @@
 ---
-meta:
-  title: Scaleway Write for the Community program
-  description: This page explains how to participate in the Scaleway Write for the Community program.
-content:
-  h1: Write for the Community program
-  paragraph: This page explains how to participate in the Scaleway Write for the Community program.
+title: Scaleway Write for the Community program
+description: This page explains how to participate in the Scaleway Write for the Community program.
 tags: write-for-the-community community contribute git voucher
-cta: false
 ---
 
 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.
diff --git a/pages/guidelines.mdx b/pages/guidelines.mdx
@@ -1,10 +1,6 @@
 ---
-meta:
-  title: Scaleway Documentation Guidelines
-  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.
-content:
-  h1: Scaleway Documentation Guidelines
-  paragraph: 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.
+title: Scaleway Documentation Guidelines
+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.
 tags: style-guide guidelines wording grammar
 dates:
   validation: 2025-02-11
@@ -99,14 +95,14 @@ If you are creating a new page, it may be easiest to duplicate an existing page
 
 More information about the different sections of each page can be found by following the links in the table above.
 
-## Page content 
+## Page content
 
 ### Headers
 
 - There can be only one H1 on each page (the page title, defined in the [metadata](#metadata))
 - 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.
 - Headers also serve as anchors. Link to a header anchor as follows `[text to display](#header-with-spaces-replaced-by-dashes)`
-- 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). 
+- 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).
 - All headers should be in [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case). Product names should nonetheless be capitalized as appropriate.
 
 ### Numbered steps
@@ -158,28 +154,28 @@ Markdown syntax:
 ````
 ```python
 my_list=[1,6,9,4]
-my_list[1]=3 
+my_list[1]=3
 print(my_list)
 ```
-```` 
+````
 
 Renders as:
 
 ```python
 my_list=[1,6,9,4]
-my_list[1]=3 
+my_list[1]=3
 print(my_list)
 ```
 
 ### Inline code
 
-Use inline code to reference information in your text, such as environment variables, placeholder values, and single-line short code snippets. 
+Use inline code to reference information in your text, such as environment variables, placeholder values, and single-line short code snippets.
 
 Markdown syntax (backticks):
 
 ````
-Do not forget to replace `<YOUR INSTANCE NAME>` with the name of your Instance.  
-```` 
+Do not forget to replace `<YOUR INSTANCE NAME>` with the name of your Instance.
+````
 
 Renders as:
 
@@ -225,14 +221,14 @@ When linking to an external page, copy and paste the full link exactly as it app
 
 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` ````.
 
-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: 
+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:
 
 ````
 ```php
 <?php
 more code here
 ?>
- 
+
 To go to the next page <A HREF="URLexample/nextpage.php">click here</A>
 ```
 ````
@@ -244,7 +240,7 @@ Use a console icon when referring in the documentation to the equivalent icon in
 | Syntax                                                              | Renders as                                                |
 | ------------------------------------------------------------------- | ---------------------------------------------------------- |
 | ````Use the toggle <Icon name="toggle" /> to activate the feature````  | Use the toggle <Icon name="toggle" /> to activate the feature |
- 
+
 See the [full list of available icons](/components/docs/#inline-console-icons).
 
 ### Messages
@@ -253,7 +249,7 @@ Three types of message boxes are available, to use as follows:
 
 | Message type | Use for                | Syntax | Renders as |
 |--------------|------------------------|--------|------------|
-| 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> | 
+| 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> |
 | 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> |
 | 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> |
 
@@ -273,15 +269,15 @@ Tabs syntax:
 
 ```
 <Tabs id="example-tabs">
-  
+
   <TabsTab label="Tab one">
     This is the content of tab one
   </TabsTab>
-  
+
   <TabsTab label="Tab two">
     This is the content of tab two
   </TabsTab>
-  
+
   <TabsTab label="Tab three">
     This is the content of tab three
   </TabsTab>
@@ -309,7 +305,7 @@ Read more about the [tab component](/components/docs/#tabs).
 
 ### Pronouns
 
-When addressing the user, say "you". When referring to Scaleway, say "Scaleway", "it", or "we". 
+When addressing the user, say "you". When referring to Scaleway, say "Scaleway", "it", or "we".
 
 | ✅ DO WRITE                                | ❌ DO NOT WRITE                                 |
 | ------------------------------------------ | ----------------------------------------------- |
@@ -340,7 +336,7 @@ Always use "click", not "click on"
 
 ### Commas
 
-Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known as the serial comma). 
+Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known as the serial comma).
 
 | ✅ DO WRITE                                | ❌ DO NOT WRITE                                 |
 | ------------------------------------------ | ----------------------------------------------- |
@@ -377,13 +373,13 @@ Use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma) (also known a
 ### Dates and times
 
 - For times, use the 24-hour format. If it is necessary to use the 12-hour format, use `a.m.` or `p.m.` appropriately
-- For dates, use `day/month/year` or `DD/MM/YY`. 
+- For dates, use `day/month/year` or `DD/MM/YY`.
 - 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).
 
 ### Bits and bytes
 
 - Add a space between the bits/bytes abbreviation and the number, e.g. `100 MB`, `1 Gbps`
-- Use the following abbreviations: 
+- Use the following abbreviations:
 
 | Term                  | Abbreviation      | Example                                  |
 | --------------------- | ------------------|----------------------------------------- |
@@ -409,8 +405,8 @@ When referring to different aspects of the Scaleway console, use the following t
 | Side menu                   | <Lightbox image={image2} alt="" />     |
 | Organization drop-down menu | <Lightbox image={image3} alt="" />          |
 | $PRODUCT_NAME dashboard, e.g. Object Storage dashboard | <Lightbox image={image4} alt="" />  |
-| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | <Lightbox image={image5} alt="" /> | 
-| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | <Lightbox image={image6} alt="" /> |           
+| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | <Lightbox image={image5} alt="" /> |
+| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | <Lightbox image={image6} alt="" /> |
 
 ### Product and feature names
 
@@ -452,12 +448,8 @@ Diagrams and schemas should be produced in accordance with Scaleway visual desig
 
 ```
 ---
-meta:
-  title: How to create an Instance
-  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.
-content:
-  h1: How to create an Instance
-  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.
+title: How to create an Instance
+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.
 tags: instance create
 dates:
   validation: 2024-06-10
@@ -467,16 +459,16 @@ categories:
 ---
 ```
 
-- **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. 
-- **content: h1**: The main title that displays on the documentation page.
-- **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). 
-- **tags**: The tags used by internal and external search engines to help users find the page 
+- **title**: The title of the page, used by external search engines and the main title that displays on the documentation page.
+- **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://www.scaleway.com/en/docs/components/docs-editor/#productcard)).
+- **tags**: The tags used by internal and external search engines to help users find the page
 - **dates: posted**: The date the page was originally created, in the format `yyyy-mm-dd`. This displays on the generated page.
-- **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. 
+- **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.
 - **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.
 
 <Message type="note">
-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:
+Titles should be in [sentence case](https://en.wikipedia.org/wiki/Letter_case#Sentence_case). Different page types should have different types of titles:
 - **How to**: How to + infinitve verb + 5 words maximum
 - **Tutorial**: Start with a gerund, e.g. "Deploying WordPress with LEMP on Ubuntu Focal Fossa"
 - **Troubleshooting**: The title should describe the problem, e.g. "Auto-configuration is not working"
