From 3d95649f4740e3654a560421a36eb48d9ec1e0b6 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Wed, 10 Dec 2025 18:18:59 +0100 Subject: [PATCH 01/14] feat(gen): update contribution guidelines --- docs/CONTRIBUTING.md | 116 +++++++++++++++++++++++++++---------------- 1 file changed, 74 insertions(+), 42 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f476205acf..4754917a37 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -19,7 +19,6 @@ Anyone who has a GitHub account can contribute to the documentation content: - You have [Git](https://git-scm.com/) installed - You have a [GitHub](https://github.com/signup) personal account -- You have installed [yarn](https://yarnpkg.com/getting-started) package manager - You have [Markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) and [MDX](https://mdxjs.com/guides/) syntax knowledge - You have read [the writing guidelines](https://www.scaleway.com/en/docs/guidelines/) @@ -29,28 +28,55 @@ Anyone who has a GitHub account can contribute to the documentation content: - All rules below concern this repository. - Any PRs which do not comply with the rules below will be rejected. -1. Clone the `docs-content` repository by following the [cloning procedure](#cloning-the-project) below. +1. Run the command below in a terminal to clone the repository: -2. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). + ```bash + git clone git@github.com:scaleway/docs-content.git + ``` -3. Create your branch locally. All branch names must comply with the following naming convention: `[source]-[action]-[product]`. +1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). + +1. Run the command below to create a local Git branch: + + ```bash + git checkout -b name-of-my-branch + ``` + + All branch names must comply with the following naming convention: `[source]-[action]-[product]`. - `source`: Either `int` (for internal Scaleway contributors) or `ext` (for external contributors). - - `action`: The action you will perform in the documentation you wish to work on, described in 3 letters or less. Example: `add` (for adding content), `rm` (for removing content) or `fix` (for when you wish to fix typos). + - `action`: The action you will perform in the documentation, described in 3 letters or less: `add` for adding content, `rm` for removing content, or `fix` to fix typos. - `product`: the name of the product that corresponds to the documentation page you will edit. :information_source: **Example:** in the branch `int-add-instances`, an internal contributor will add information to a documentation page of the Instances product category. -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. +1. 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. + +1. Run the command below to stage your changes before committing them: + + ```bash + git add path/to/files + ``` + +1. Run the command below to create a new commit containing the changes previously staged. Refer to the [commit naming conventions](#commit-conventions) below to properly name your commit. -5. Run `git commit -m "type(module): description with some words "`. Refer to the [commit naming conventions](#commit-conventions) below to properly name your commit. + ```bash + git commit -m "docs(product): description with some words" + ```` -6. Run `git push --set-upstream origin `, and go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request. +1. Run the command below to push your changes to the remote repository: - All PR names must comply with the following naming convention: `docs($PRODUCTNAME): $FIXEXPLANATION BRANCHNAME`. + ``` + git push --set-upstream origin + ``` + +1. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request. + + All pull requests names must comply with the following naming convention: + `docs(product_name): description with some words`. :warning: **Important** @@ -68,24 +94,49 @@ Anyone who has a GitHub account can contribute to the documentation content: 2. Keep the default values in the form, and click **Create Fork**. -3. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). +1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). + +1. Run the command below to create a local Git branch: + + ```bash + git checkout -b name-of-my-branch + ``` -4. Create your branch locally. All branch names must comply with the following naming convention: `[source]-[action]-[product]`. + All branch names must comply with the following naming convention: `[source]-[action]-[product]`. - - `source`: Either `int` (for internal Scaleway contributors) or `ext` (for external contributors). If you are not a Scaleway staff member, use `ext`. + - `source`: Either `int` (for internal Scaleway contributors) or `ext` (for external contributors). - - `action`: The action you will perform in the documentation you wish to work on, described in 3 letters or less. Example: `add` (for adding content), `rm` (for removing content) or `fix` (for when you wish to fix typos). + - `action`: The action you will perform in the documentation, described in 3 letters or less: `add` for adding content, `rm` for removing content, or `fix` to fix typos. - `product`: the name of the product that corresponds to the documentation page you will edit. :information_source: **Example:** in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. -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. +1. 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. + +1. Run the command below to stage your changes before committing them: + + ```bash + git add path/to/files + ``` -5. Run `git commit -m "type(module): description of what you performed "`. Refer to the [commit naming conventions](#commit-conventions) below to properly name your commit. +1. Run the command below to create a new commit containing the changes previously staged. Refer to the [commit naming conventions](#commit-conventions) below to properly name your commit. -6. Run `git push --set-upstream origin `, and go to the pull request page of the **forked** repository to open a pull request. + ```bash + git commit -m "docs(product): description with some words" + ```` + +1. Run the command below to push your changes to the remote repository: + + ``` + git push --set-upstream origin + ``` + +1. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request. + + All pull requests names must comply with the following naming convention: + `docs(product_name): description with some words`. 7. Click **Create pull request**, then select @@ -106,30 +157,15 @@ Anyone who has a GitHub account can contribute to the documentation content: --- -## Use the repository locally - -You have to clone the project locally to work on it. - -:warning: - If you are not a member of the Scaleway organization, you need to fork the repository. [Follow this link](https://docs.github.com/en/get-started/quickstart/fork-a-repo) to find out how. - -### Cloning the project +## Reference -1. Copy the following code and enter it in your terminal: - -```bash -git clone git@github.com:scaleway/docs-content.git | bash -s -- cd docs-content && yarn -``` - -2. Ensure `yarn` has been run, if not run `yarn install`. - -## Git commit +### Git commit Helpful pre-commit commands: - `pnpm check-slugs` Output slugs that are not kebab-case well formatted. -### Commit conventions +#### Commit conventions This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) based on the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). @@ -154,7 +190,7 @@ Here is the list of `type` to use (commons in bold): - `style` - _For simple format changes that are not content changes_ -### Commit examples +#### Commit examples `feat(console): add vpc how-to page MTA-2342` @@ -164,7 +200,7 @@ Here is the list of `type` to use (commons in bold): --- -## Markdown +### Markdown Markdown is a lightweight markup language for creating formatted text using a plain-text editor. @@ -174,19 +210,15 @@ As we need to use evolved dynamic and designed blocks, for the Scaleway Document With MDX files traditional markdown content can be used with React components. -### MDX components +#### MDX components MDX components are useful for adding rich content and interactions within your contributions. -#### Components - -This section shows code details listed on a full page. - 🔎 [See the full Components page](https://storybook-docs.scaleway.com/). Feel free to explore this page in your markdown editor to see how the components were used, or in `.mdx` content files that already use MDX components. -### Frontmatter +#### Frontmatter Any Markdown file that contains a YAML frontmatter block will be processed by Gatsby as a special file. 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. From c7e7f0103325e52f4e6e4465dddfc49a434685d7 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Wed, 10 Dec 2025 18:23:06 +0100 Subject: [PATCH 02/14] feat(gen): update --- docs/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4754917a37..2847056e7d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -135,9 +135,6 @@ Anyone who has a GitHub account can contribute to the documentation content: 1. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request. - All pull requests names must comply with the following naming convention: - `docs(product_name): description with some words`. - 7. Click **Create pull request**, then select - base repository: `scaleway/docs-content` @@ -150,7 +147,8 @@ Anyone who has a GitHub account can contribute to the documentation content: 8. Click **Create pull request**. - All pull requests names must comply with the following naming convention: `docs(): `. + All pull requests names must comply with the following naming convention: + `docs(product_name): description with some words`. :warning: **Important** All pull requests are reviewed and approved by the Scaleway Product Documentation team before being merged by them. @@ -244,6 +242,8 @@ Here starts the content… - `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 Refer to the [Scaleway Documentation Guidelines](https://www.scaleway.com/en/docs/guidelines/) for an extensive list of our writing guidelines. From 7b19dc12950cf5a675339e968a6a3ee362d36fa1 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:07:40 +0100 Subject: [PATCH 03/14] feat(gen): update --- docs/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2847056e7d..1d1bfbb992 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,10 +28,10 @@ Anyone who has a GitHub account can contribute to the documentation content: - All rules below concern this repository. - Any PRs which do not comply with the rules below will be rejected. -1. Run the command below in a terminal to clone the repository: +1. Run the command below in a terminal to clone the repository and access it: ```bash - git clone git@github.com:scaleway/docs-content.git + git clone git@github.com:scaleway/docs-content.git && cd docs-content ``` 1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). From 3df5485f6a1de1e599e6ee87deb033cd36c8a088 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:50:04 +0100 Subject: [PATCH 04/14] feat(gen): update --- docs/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1d1bfbb992..b9cf941c61 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -13,6 +13,10 @@ Anyone who has a GitHub account can contribute to the documentation content: - External users (i.e. not part of the Scaleway organization) must [fork the repository and open a pull request from the forked repository](#contribution-procedure-for-external-users). +## Can I build the documentation locally? + +No, this repository only hosts the documentation site **content**, and does not include any of the frontend or backend components required to build or render the site. Internal Scaleway users must refer to the dedicated internal guidelines to build previews of the documentation. + ## How to contribute? ### Prerequisites From 1d5efe58c4b1040b8093c20c25564bbcd3fc3cb9 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:51:51 +0100 Subject: [PATCH 05/14] feat(gen): update --- docs/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index b9cf941c61..17fa957596 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,9 +28,9 @@ No, this repository only hosts the documentation site **content**, and does not ### Contribution procedure for internal Scaleway users -:warning: **Important** - - All rules below concern this repository. - - Any PRs which do not comply with the rules below will be rejected. +> [!IMPORTANT] +> - All rules below concern this repository. +> - Any PRs which do not comply with the rules below will be rejected. 1. Run the command below in a terminal to clone the repository and access it: From 38a15c8510e8a833e4bc34abbaa1de0e8204e907 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:52:09 +0100 Subject: [PATCH 06/14] feat(gen): update --- docs/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 17fa957596..6a23819400 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,9 +28,9 @@ No, this repository only hosts the documentation site **content**, and does not ### Contribution procedure for internal Scaleway users -> [!IMPORTANT] -> - All rules below concern this repository. -> - Any PRs which do not comply with the rules below will be rejected. + > [!IMPORTANT] + > - All rules below concern this repository. + > - Any PRs which do not comply with the rules below will be rejected. 1. Run the command below in a terminal to clone the repository and access it: From 50aa013eed4ea73d2e75581b4c2ec02fc8dc3bad Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:54:15 +0100 Subject: [PATCH 07/14] feat(gen): update --- docs/CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6a23819400..c54b02add2 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -28,9 +28,9 @@ No, this repository only hosts the documentation site **content**, and does not ### Contribution procedure for internal Scaleway users - > [!IMPORTANT] - > - All rules below concern this repository. - > - Any PRs which do not comply with the rules below will be rejected. +> [!IMPORTANT] +> - All rules below concern this repository. +> - Any PRs which do not comply with the rules below will be rejected. 1. Run the command below in a terminal to clone the repository and access it: @@ -83,16 +83,16 @@ No, this repository only hosts the documentation site **content**, and does not `docs(product_name): description with some words`. -:warning: **Important** - All PRs are reviewed and approved by the Scaleway Product Documentation team before being merged by them. +> [!IMPORTANT] +> All PRs are reviewed and approved by the Scaleway Product Documentation team before being merged by them. --- ### Contribution procedure for external users -:warning: **Important** - - All rules below concern this repository. - - Any PRs which do not comply with the rules below will be rejected. +> [!IMPORTANT] +> - All rules below concern this repository. +> - Any PRs which do not comply with the rules below will be rejected. 1. Access the [docs-content repository](https://github.com/scaleway/docs-content/), and click **Fork** in the top right corner. A form appears. @@ -114,8 +114,8 @@ No, this repository only hosts the documentation site **content**, and does not - `product`: the name of the product that corresponds to the documentation page you will edit. - :information_source: **Example:** - in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. + > [!TIP] + > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. 1. 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. From 5270f1e4808549ca23753747c5e7b5ce6ebf22ef Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:54:45 +0100 Subject: [PATCH 08/14] feat(gen): update --- docs/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c54b02add2..87bdfc3ad0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -114,8 +114,8 @@ No, this repository only hosts the documentation site **content**, and does not - `product`: the name of the product that corresponds to the documentation page you will edit. - > [!TIP] - > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. +> [!TIP] +> **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. 1. 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. From 7e47399b44e6d1730231b07ca70f54c109d85c84 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:55:12 +0100 Subject: [PATCH 09/14] feat(gen): update --- docs/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 87bdfc3ad0..484e719872 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -114,8 +114,8 @@ No, this repository only hosts the documentation site **content**, and does not - `product`: the name of the product that corresponds to the documentation page you will edit. -> [!TIP] -> **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. + > [!TIP] + > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. 1. 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. From 9f2ad78ef72f67272da9f7d4498e5c4ad71c1af4 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:55:31 +0100 Subject: [PATCH 10/14] feat(gen): update --- docs/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 484e719872..c54b02add2 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -114,8 +114,8 @@ No, this repository only hosts the documentation site **content**, and does not - `product`: the name of the product that corresponds to the documentation page you will edit. - > [!TIP] - > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. + > [!TIP] + > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. 1. 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. From 28dbadbec74b2525e1864a2aeb4eb91579af22f9 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 10:59:55 +0100 Subject: [PATCH 11/14] feat(gen): update --- docs/CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c54b02add2..eca0000b84 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -113,10 +113,9 @@ No, this repository only hosts the documentation site **content**, and does not - `action`: The action you will perform in the documentation, described in 3 letters or less: `add` for adding content, `rm` for removing content, or `fix` to fix typos. - `product`: the name of the product that corresponds to the documentation page you will edit. - > [!TIP] > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. - + 1. 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. 1. Run the command below to stage your changes before committing them: From d7a6a1437f48c32e9a71760e50848dd7e9d3046d Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 11:01:31 +0100 Subject: [PATCH 12/14] feat(gen): update --- docs/CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index eca0000b84..902d844d82 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -113,9 +113,10 @@ No, this repository only hosts the documentation site **content**, and does not - `action`: The action you will perform in the documentation, described in 3 letters or less: `add` for adding content, `rm` for removing content, or `fix` to fix typos. - `product`: the name of the product that corresponds to the documentation page you will edit. - > [!TIP] - > **Example**: in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. - + + :information_source: **Example:** + in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category. + 1. 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. 1. Run the command below to stage your changes before committing them: @@ -138,7 +139,7 @@ No, this repository only hosts the documentation site **content**, and does not 1. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request. -7. Click **Create pull request**, then select +1. Click **Create pull request**, then select - base repository: `scaleway/docs-content` @@ -148,13 +149,13 @@ No, this repository only hosts the documentation site **content**, and does not - compare: `` -8. Click **Create pull request**. +1. Click **Create pull request**. All pull requests names must comply with the following naming convention: `docs(product_name): description with some words`. -:warning: **Important** - All pull requests are reviewed and approved by the Scaleway Product Documentation team before being merged by them. +> [!IMPORTANT] +> All PRs are reviewed and approved by the Scaleway Product Documentation team before being merged by them. --- From 4a897f8b5ba8d5713915d911aa07ec18d90d3820 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Fri, 12 Dec 2025 11:05:10 +0100 Subject: [PATCH 13/14] Apply suggestions from code review Co-authored-by: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> --- docs/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 902d844d82..cc8f1f3685 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -38,7 +38,7 @@ No, this repository only hosts the documentation site **content**, and does not git clone git@github.com:scaleway/docs-content.git && cd docs-content ``` -1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). +1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write or edit (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). 1. Run the command below to create a local Git branch: @@ -98,7 +98,7 @@ No, this repository only hosts the documentation site **content**, and does not 2. Keep the default values in the form, and click **Create Fork**. -1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). +1. Make sure you have identified the [type of content](https://github.com/scaleway/docs-content#what-is-the-scaleway-documentation-platform) that you want to write or edit (e.g. tutorial, API/CLI documentation, additional content or troubleshooting). 1. Run the command below to create a local Git branch: From 61276c4bd97cd2e8bb9a7b197d3c9d60dd65d344 Mon Sep 17 00:00:00 2001 From: Samy OUBOUAZIZ Date: Fri, 12 Dec 2025 11:06:37 +0100 Subject: [PATCH 14/14] feat(gen): update --- docs/CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index cc8f1f3685..66d53bd8cd 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -216,7 +216,8 @@ With MDX files traditional markdown content can be used with React components. MDX components are useful for adding rich content and interactions within your contributions. -🔎 [See the full Components page](https://storybook-docs.scaleway.com/). +> [!TIP] +> [See the full Components page](https://storybook-docs.scaleway.com/). Feel free to explore this page in your markdown editor to see how the components were used, or in `.mdx` content files that already use MDX components.