From 34b5c6125a20067b60959be5b69c22d13743a912 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=A9da?= <87707325+nerda-codes@users.noreply.github.com> Date: Wed, 16 Apr 2025 10:13:29 +0200 Subject: [PATCH 1/2] docs(sem): add secret deletion (#4851) --- menu/navigation.json | 12 ++++- pages/secret-manager/concepts.mdx | 14 ++++-- pages/secret-manager/faq.mdx | 4 +- pages/secret-manager/how-to/delete-secret.mdx | 19 ++++---- .../secret-manager/how-to/delete-version.mdx | 12 +++-- .../secret-manager/how-to/recover-secrets.mdx | 48 +++++++++++++++++++ .../secret-manager/how-to/recover-version.mdx | 38 +++++++++++++++ 7 files changed, 125 insertions(+), 22 deletions(-) create mode 100644 pages/secret-manager/how-to/recover-secrets.mdx create mode 100644 pages/secret-manager/how-to/recover-version.mdx diff --git a/menu/navigation.json b/menu/navigation.json index 6d6867bb14..e347a21d35 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -576,12 +576,20 @@ "slug": "manage-version" }, { - "label": "Delete a secret", + "label": "Schedule a secret deletion", "slug": "delete-secret" }, { - "label": "Delete a version", + "label": "Schedule a version deletion", "slug": "delete-version" + }, + { + "label": "Recover secrets scheduled for deletion", + "slug": "recover-secrets" + }, + { + "label": "Recover a version scheduled for deletion", + "slug": "recover-version" } ], "label": "How to", diff --git a/pages/secret-manager/concepts.mdx b/pages/secret-manager/concepts.mdx index 7b2fb3b61e..d00c70eda5 100644 --- a/pages/secret-manager/concepts.mdx +++ b/pages/secret-manager/concepts.mdx @@ -7,7 +7,7 @@ content: paragraph: Discover essential concepts of Scaleway Secret Manager, including secret versioning, ephemeral policies, and path management. tags: secret-manager secret version dates: - validation: 2025-01-13 + validation: 2025-04-15 --- ## Disabling a version @@ -109,12 +109,18 @@ Secret types refer to the different kinds of sensitive data you can store with S Upon secret creation, you must choose a secret type that will also be applied to the secret version. All the secret's subsequent versions must be of the same type. +## Scheduled deletion + +Scheduled deletion lets you mark a secret and its versions for deletion ahead of time. Instead of immediate deletion, the secret enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-secrets/). + +During this time, you can read secret versions but cannot edit, access, or delete them. After the retention period, the secret and all its versions are permanently deleted. You can also schedule a secret version for deletion without impacting the secret associated with the version. + +Recovering deleted secrets is billed €0.01 per version associated with the secret. + ## Tag Tags allow you to organize your secrets. This gives you the possibility of sorting and filtering your secrets in any organizational pattern of your choice, which in turn helps you arrange, control, and monitor your secrets. ## Version -Versions store the data contained in your secret (API keys, passwords, or certificates). Versions can be [**enabled**](#enabling-a-version) or [**disabled**](#disabling-a-version) depending on your usage. Versions must be of the same type as the secret they belong to. - - +Versions store the data contained in your secret (API keys, passwords, or certificates). Versions can be [**enabled**](#enabling-a-version) or [**disabled**](#disabling-a-version) depending on your usage. Versions must be of the same type as the secret they belong to. \ No newline at end of file diff --git a/pages/secret-manager/faq.mdx b/pages/secret-manager/faq.mdx index e8ce9f71be..a5de3b9052 100644 --- a/pages/secret-manager/faq.mdx +++ b/pages/secret-manager/faq.mdx @@ -5,7 +5,7 @@ meta: content: h1: Secret Manager FAQ dates: - validation: 2025-04-01 + validation: 2025-04-15 category: identity-and-access-management productIcon: SecretManagerProductIcon --- @@ -40,3 +40,5 @@ To understand the secrets encryption process, refer to our [related documentatio At the end of the month, you are billed for the number of secret versions stored and API requests made on the service. A secret version is billed if it is in an enabled or disabled state. If, for example, you have used a secret version for five days, you will only be billed for the five days and not for the whole month. Find out more about pricing on our [dedicated page](https://www.scaleway.com/en/pricing/?tags=available). + +Recovering secrets [scheduled for deletion](/secret-manager/concepts/#scheduled-deletion) is billed €0.01 per version associated with the secret. \ No newline at end of file diff --git a/pages/secret-manager/how-to/delete-secret.mdx b/pages/secret-manager/how-to/delete-secret.mdx index 738f2581a7..072818d113 100644 --- a/pages/secret-manager/how-to/delete-secret.mdx +++ b/pages/secret-manager/how-to/delete-secret.mdx @@ -5,15 +5,17 @@ meta: content: h1: How to delete a secret paragraph: Discover how to securely delete secrets using Scaleway's intuitive console. Follow these steps to manage your sensitive data effectively. -tags: secret sensitive-data storage-system +tags: secret sensitive-data storage-system schedule-deletion dates: - validation: 2025-03-14 + validation: 2025-04-15 posted: 2023-02-21 categories: - identity-and-access-management --- -This page explains how to delete a [secret](/secret-manager/concepts/#secret) using the [Scaleway console](https://console.scaleway.com). You **cannot delete protected secrets**, i.e. secrets to which you have applied [secret protection](/secret-manager/concepts/#secret-protection). +This page explains how to [schedule a secret deletion](/secret-manager/concepts/#scheduled-deletion) using the [Scaleway console](https://console.scaleway.com). You **cannot delete protected secrets**, i.e. secrets to which you have applied [secret protection](/secret-manager/concepts/#secret-protection). + +Once you schedule a secret for deletion, it enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-secrets/). After this retention period, the secret and all its versions are permanently deleted. @@ -25,13 +27,10 @@ This page explains how to delete a [secret](/secret-manager/concepts/#secret) us 1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu. 2. Select the [region](/secret-manager/concepts/#region) in which to delete the secret, in the **Region** drop-down. -3. Access the secret you wish to delete. The secret's **Overview** tab displays. -4. Scroll down and click **Delete secret**. A pop-up displays. -5. Type **DELETE** and click **Delete secret**. +3. Click next to the secret you want to delete and click **Delete**. A pop-up displays informing you that the action schedules the deletion of your secret and its version. +4. Type **DELETE** and click **Delete secret** to confirm. Your secret displays in the **Scheduled for deletion** tab for a period of 7 days before being permanently deleted. - - Although you cannot delete a [protected secret](/secret-manager/concepts/#secret-protection), you can delete its versions - - Deleting a secret is a permanent action. It erases every version you have created for your secret + - Although you cannot delete a [protected secret](/secret-manager/concepts/#secret-protection), you can delete its versions. + - Deleting a secret is a permanent action. It erases every version you have created for your secret if you do not [recover it](/secret-manager/how-to/recover-secrets/) before the end of the retention period. - - diff --git a/pages/secret-manager/how-to/delete-version.mdx b/pages/secret-manager/how-to/delete-version.mdx index 67eb94df2e..da2ef80afa 100644 --- a/pages/secret-manager/how-to/delete-version.mdx +++ b/pages/secret-manager/how-to/delete-version.mdx @@ -7,13 +7,15 @@ content: paragraph: Learn how to securely delete versions of secrets using the Scaleway console. Follow these steps to effectively manage your sensitive data. tags: sensitive-data storage-system api-key dates: - validation: 2025-03-14 + validation: 2025-04-15 posted: 2023-02-21 categories: - identity-and-access-management --- -This page explains how to delete a secret [version](/secret-manager/concepts/#version) using the [Scaleway console](https://console.scaleway.com). +This page explains how to [schedule](/secret-manager/concepts/#scheduled-deletion) a [version](/secret-manager/concepts/#version) deletion using the [Scaleway console](https://console.scaleway.com). + +Once you schedule a version for deletion, it enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-version/). After this retention period, the version is permanently deleted. @@ -27,11 +29,11 @@ This page explains how to delete a secret [version](/secret-manager/concepts/#ve 3. Access the secret for which you want to delete the version. Your secret's **Overview** tab displays. 4. Click the **Versions** tab. 5. Click next to the version you want to delete. -6. Click **Delete**. A pop-up displays. -7. Type **DELETE** and click **Delete version**. +6. Click **Delete**. A pop-up displays informating you that the action schedules the deletion of your version. +7. Type **DELETE** and click **Delete version**. Your version enters the **Scheduled for deletion** status for a period of 7 days before being permanently deleted. - Deleting a version is permanent. You will not be able to use the version again. + Deleting a version is permanent. You will not be able to use the version again if you do not [recover it](/secret-manager/how-to/recover-version/) before the end of the retention period. diff --git a/pages/secret-manager/how-to/recover-secrets.mdx b/pages/secret-manager/how-to/recover-secrets.mdx new file mode 100644 index 0000000000..f0c7a339ad --- /dev/null +++ b/pages/secret-manager/how-to/recover-secrets.mdx @@ -0,0 +1,48 @@ +--- +meta: + title: How to recover secrets scheduled for deletion + description: Recover secrets scheduled for deletion in the Scaleway console before they are permanently removed. +content: + h1: How to recover secrets scheduled for deletion + paragraph: Recover secrets scheduled for deletion in the Scaleway console before they are permanently removed. +tags: secret sensitive-data scheduled-deletion recover-secret +dates: + validation: 2025-04-15 + posted: 2025-04-15 +categories: + - identity-and-access-management +--- + +This page shows you how to recover secrets scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a secret for deletion, it enters a 7-day pending deletion period, during which you can still recover it. +After this retention period, the secret and all its versions are permanently deleted. + + + Scheduled deletion deletes ephemeral secrets and their versions immediately. + + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Created a [secret](/secret-manager/how-to/create-secret/) +- Scheduled secrets for deletion + +## How to recover one secret + +1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Select the [region](/secret-manager/concepts/#region) in which to recover the secret, in the **Region** drop-down. +3. Click the **Scheduled for deletion** tab. Your secrets display. +4. Click next to the secret you want to recover and click **Recover**. A pop-up displays the estimated cost of recovering the secret. + + Recovering a secret is billed €0.01 per version associated with the secret. + +5. Click **Recover secret** to confirm. Your secret displays in the **Secrets** tab. + +## How to recover several secrets + +1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Select the [region](/secret-manager/concepts/#region) in which to recover the secret, in the **Region** drop-down. +3. Click the **Scheduled for deletion** tab. Your secrets display. +4. Tick the checkbox next to **Name** to select all the secrets you want to recover. +5. Click the circular arrow to recover the selected secrets. +6. Check the estimated cost and click **Recover secrets** to confirm. \ No newline at end of file diff --git a/pages/secret-manager/how-to/recover-version.mdx b/pages/secret-manager/how-to/recover-version.mdx new file mode 100644 index 0000000000..ec2dfd5a33 --- /dev/null +++ b/pages/secret-manager/how-to/recover-version.mdx @@ -0,0 +1,38 @@ +--- +meta: + title: How to recover a version scheduled for deletion + description: Recover a version scheduled for deletion in the Scaleway console before it is permanently removed. +content: + h1: How to recover a version scheduled for deletion + paragraph: Recover a version scheduled for deletion in the Scaleway console before it is permanently removed. +tags: secret sensitive-data scheduled-deletion recover-version +dates: + validation: 2025-04-15 + posted: 2025-04-15 +categories: + - identity-and-access-management +--- + +This page shows you how to recover a version scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a version for deletion, it enters a 7-day pending deletion period, during which you can still recover it. +After this retention period, the version is permanently deleted. + + + Scheduled deletion deletes ephemeral secrets and their versions immediately. + + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Created a [version](/secret-manager/how-to/create-version/) +- Scheduled a version for deletion + +1. Click **Secret Manager** in the **Security and Identity** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Select the [region](/secret-manager/concepts/#region) in which to recover the version, in the **Region** drop-down. +3. Access the secret for which you want to recover the version. Your secret's **Overview** tab displays. +4. Click the **Versions** tab. +5. Click next to the version you want to recover, and click **Recover**. A pop-up displays the estimated cost of recovering the version. + + Recovering a version is billed €0.01. + +6. Click **Recover version** to confirm. You version displays in the **Versions** tab with the same status as before the scheduled deletion. \ No newline at end of file From efc2ce7db1bf76dbf3d4113b831dbbd380218a3c Mon Sep 17 00:00:00 2001 From: Emmanuel Barachant Date: Tue, 15 Jul 2025 13:48:59 +0200 Subject: [PATCH 2/2] docs: update contribution frontmatter - WDOC-1102 --- docs/CONTRIBUTING.md | 19 +++------ docs/DOC_PAGE_TEMPLATE.mdx | 12 ++---- docs/TROUBLESHOOTING_TEMPLATE.mdx | 8 +--- pages/contribute.mdx | 9 +--- pages/guidelines.mdx | 70 ++++++++++++++----------------- 5 files changed, 45 insertions(+), 73 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5f92953b1d..16b6a70575 100644 --- 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 index d261b699db..44f770e5df 100644 --- 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 index 0d0ea2a2da..a7eefc8bcc 100644 --- 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 index 6927c9bd13..30351d3020 100644 --- 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 index 44859c0aa4..905e7da98d 100644 --- 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 `` with the name of your Instance. -```` +Do not forget to replace `` 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 `` tag or similar, include the keyword `URLexample` in the URL: +When including a "fake" or example link in a code box with an `` tag or similar, include the keyword `URLexample` in the URL: ```` ```php - + To go to the next page click here ``` ```` @@ -244,7 +240,7 @@ Use a console icon when referring in the documentation to the equivalent icon in | Syntax | Renders as | | ------------------------------------------------------------------- | ---------------------------------------------------------- | | ````Use the toggle to activate the feature```` | Use the 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 | ```` ```` | This is a note | +| Note | Extra information that may not be relevant in all cases or to all users | ```` ```` | This is a note | | Tip | Information about a different way to accomplish something, or how to go further | ```` ```` | This is a tip | | Important | Critical warnings and information that the user must read to avoid unwanted consequences or mistakes | ```` ```` | This is important | @@ -273,15 +269,15 @@ Tabs syntax: ``` - + This is the content of tab one - + This is the content of tab two - + This is the content of tab three @@ -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 | | | Organization drop-down menu | | | $PRODUCT_NAME dashboard, e.g. Object Storage dashboard | | -| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | | -| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | | +| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | | +| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | | ### 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. -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"