Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: false
contact_links:
- name: Scaleway assistance
url: https://console.scaleway.com/support/tickets/
about: Contact Scaleway Assistance for help with product-related issues.
about: Contact Scaleway Assistance for help with product-related issues.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/doc_bug.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Documentation bug
description: Raise an issue related to content.
title: "🐞 Documentation Bug: "
labels: "Documentation Bug"
title: '🐞 Documentation Bug: '
labels: 'Documentation Bug'
body:
- type: markdown
attributes:
Expand All @@ -11,7 +11,7 @@ body:
- type: input
attributes:
label: What content on scaleway.com/en/docs is affected?
placeholder: "https://www.scaleway.com/en/docs/"
placeholder: 'https://www.scaleway.com/en/docs/'
validations:
required: true
- type: textarea
Expand All @@ -26,12 +26,12 @@ body:
- type: textarea
attributes:
label: Additional context
placeholder: "Add any other context or screenshots about the feature request here."
placeholder: 'Add any other context or screenshots about the feature request here.'
validations:
required: false
- type: textarea
attributes:
label: Related PR(s)
placeholder: "Let us know if this is related to an open pull request"
placeholder: 'Let us know if this is related to an open pull request'
validations:
required: false
required: false
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/doc_request.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Documentation request
description: Suggest a topic or new documentation you think we should add.
title: "👩‍💻 Documentation Request: "
labels: "Documentation Request"
title: '👩‍💻 Documentation Request: '
labels: 'Documentation Request'
body:
- type: markdown
attributes:
Expand All @@ -27,19 +27,19 @@ body:
attributes:
label: Want to write this documentation yourself?
options:
- "Yes"
- "No"
- 'Yes'
- 'No'
validations:
required: true
- type: textarea
attributes:
label: Related PR(s)
placeholder: "Let us know if this is related to an open pull request."
placeholder: 'Let us know if this is related to an open pull request.'
validations:
required: false
- type: textarea
attributes:
label: Email address
placeholder: "Leave us your email address in case we need to contact you."
placeholder: 'Leave us your email address in case we need to contact you.'
validations:
required: false
4 changes: 1 addition & 3 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
'type: developer':
- .github/**
- .husky/**
- bin/**
- .prettierrc
- commitlint.config.js
- .oxfmtrc.json
- package.json

'type: changelog':
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/do-not-merge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
run: |
echo "Pull request is labeled as 'do not merge'"
echo "This workflow fails so that the pull request cannot be merged"
exit 1
exit 1
5 changes: 2 additions & 3 deletions .github/workflows/draft.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

name: "Draft"
name: 'Draft'
on:
pull_request_target:
types: [converted_to_draft]
Expand All @@ -15,4 +14,4 @@ jobs:
uses: actions-ecosystem/action-add-labels@v1
with:
labels: |
status: draft
status: draft
5 changes: 2 additions & 3 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: "Pull Request Labeler"
on:
pull_request_target
name: 'Pull Request Labeler'
on: pull_request_target

jobs:
triage:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/remove-draft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ jobs:
- uses: actions-ecosystem/action-remove-labels@v1
with:
labels: |
status: draft
status: draft
17 changes: 17 additions & 0 deletions .oxfmtrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"singleQuote": true,
"trailingComma": "all",
"semi": false,
"arrowParens": "avoid",
"tabWidth": 2,
"printWidth": 80,
"sortPackageJson": false,
"ignorePatterns": [
"node_modules/",
"package.json",
"pnpm-lock.yaml",
"*.mdx",
"styles/"
]
}
4 changes: 0 additions & 4 deletions .prettierignore

This file was deleted.

7 changes: 0 additions & 7 deletions .prettierrc

This file was deleted.

1 change: 0 additions & 1 deletion docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ We are committed to maintaining a community where users are free to express them
Restrictions are temporary where feasible, and do not serve the purpose of purging or restricting any specific dual-use content, or copies of that content, from the platform in perpetuity. While we aim to make these rare cases of restriction a collaborative process with project owners, if you do feel your content was unduly restricted, we have an [appeals process](#appeal-and-reinstatement) in place.

To facilitate a path to abuse resolution with project maintainers themselves, prior to escalation to GitHub abuse reports, we recommend, but do not require, that repository owners take the following steps when posting potentially harmful security research content:

- Clearly identify and describe any potentially harmful content in a disclaimer in the project's README.md file or source code comments.
- Provide a preferred contact method for any 3rd party abuse inquiries through a SECURITY.md file in the repository (e.g. "Please create an issue on this repository for any questions or concerns"). Such a contact method allows 3rd parties to reach out to project maintainers directly and potentially resolve concerns without the need to file abuse reports.

Expand Down
125 changes: 62 additions & 63 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,59 +29,58 @@ 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.
>
> - 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:

```bash
git clone git@github.com:scaleway/docs-content.git && cd docs-content
```
```bash
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 or edit (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
```
```bash
git checkout -b name-of-my-branch
```

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

- `source`: Either `int` (for internal Scaleway contributors) or `ext` (for external contributors).
- `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.

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

- `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.
:information_source: **Example:**
in the branch `int-add-instances`, an internal 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 style guide.

1. Run the command below to stage your changes before committing them:

```bash
git add path/to/files
```
```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.

```bash
git commit -m "docs(product): description with some words"
````
```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 <YOUR_BRANCH_NAME>
```

1. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request.
```
git push --set-upstream origin <YOUR_BRANCH_NAME>
```

All pull requests names must comply with the following naming convention:
`docs(product_name): description with some words`.
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`.

> [!IMPORTANT]
> All PRs are reviewed and approved by the Scaleway Product Documentation team before being merged by them.
Expand All @@ -91,68 +90,68 @@ No, this repository only hosts the documentation site **content**, and does not
### Contribution procedure for external users

> [!IMPORTANT]
> - All rules below concern this repository.
> - Any PRs which do not comply with the rules below will be rejected.
>
> - 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.

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 or edit (e.g. tutorial, API/CLI documentation, additional content or troubleshooting).
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 or edit (e.g. tutorial, API/CLI documentation, additional content or troubleshooting).

1. Run the command below to create a local Git branch:
4. Run the command below to create a local Git branch:

```bash
git checkout -b name-of-my-branch
```
```bash
git checkout -b name-of-my-branch
```

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

- `source`: Either `int` (for internal Scaleway contributors) or `ext` (for external contributors).
- `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.

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

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

:information_source: **Example:**
in the branch `ext-add-instances`, an external contributor will add information to a documentation page of the Instances product category.
5. 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.
6. Run the command below to stage your changes before committing them:

1. Run the command below to stage your changes before committing them:
```bash
git add path/to/files
```

```bash
git add path/to/files
```
7. 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.

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.
```bash
git commit -m "docs(product): description with some words"
```

```bash
git commit -m "docs(product): description with some words"
````
8. Run the command below to push your changes to the remote repository:

1. Run the command below to push your changes to the remote repository:
```
git push --set-upstream origin <YOUR_BRANCH_NAME>
```

```
git push --set-upstream origin <YOUR_BRANCH_NAME>
```

1. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request.
9. Go to [the pull requests page](https://github.com/scaleway/docs-content/pulls) to open a pull request.

1. Click **Create pull request**, then select
10. Click **Create pull request**, then select

- base repository: `scaleway/docs-content`
- base repository: `scaleway/docs-content`

- base: `main`
- base: `main`

- head repository: `<your-account>/docs-content`
- head repository: `<your-account>/docs-content`

- compare: `<your-branch-with-changes>`
- compare: `<your-branch-with-changes>`

1. Click **Create pull request**.

All pull requests names must comply with the following naming convention:
`docs(product_name): description with some words`.
All pull requests names must comply with the following naming convention:
`docs(product_name): description with some words`.

> [!IMPORTANT]
> All PRs are reviewed and approved by the Scaleway Product Documentation team before being merged by them.
Expand Down
6 changes: 3 additions & 3 deletions docs/templates/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ export const productnameMenu = {
slug: 'manage-x',
},
{
label: "Delete a <product-name>",
slug: "delete-a-<product-name>"
}
label: 'Delete a <product-name>',
slug: 'delete-a-<product-name>',
},
],
label: 'How to',
slug: 'how-to',
Expand Down
2 changes: 1 addition & 1 deletion menu/changelogs.json
Original file line number Diff line number Diff line change
Expand Up @@ -354,4 +354,4 @@
"label": "Partners",
"icon": "PartnersCategoryIcon"
}
]
]
2 changes: 1 addition & 1 deletion menu/filters.json
Original file line number Diff line number Diff line change
Expand Up @@ -317,4 +317,4 @@
"label": "Partners",
"icon": "PartnersCategoryIcon"
}
]
]
2 changes: 1 addition & 1 deletion menu/mainLinks.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@
"slug": "https://github.com/scaleway/docs-content"
}
]
}
}
Loading
Loading