> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/ovh/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# How to contribute
> Learn how to submit improvements, fix errors, and create new guides for OVHcloud documentation.
OVHcloud documentation is open to community contributions. You can update existing guides, complete them, or create new ones. All contributions are reviewed by the Technical Copywriters team before being published to [help.ovhcloud.com/csm](https://help.ovhcloud.com/csm).
## Who can contribute
Fork the repository, write your changes, then open a pull request from your fork to the `ovh/docs` repo.
Do not use a fork. Contact the OVHcloud Guides Team to be granted write access to the repository directly.
If you are an OVHcloud employee, do not fork the repository. Contact the OVHcloud Guides Team to get write access instead.
## Contribution workflow
[Fork the ovh/docs repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) to your own GitHub account.
Make your edits on your fork. Follow the [style guide](/contributing/style-guide) for file structure, naming conventions, and formatting requirements.
Before writing, verify and test every action you describe. Do not write about anything you cannot test yourself.
[Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) from your fork to the `develop` branch of the `ovh/docs` repository.
Use the pull request format described below and include a description of your contribution.
The Technical Copywriters team reviews your pull request for style and technical accuracy. Changes may be applied before merging. Once validated, your contribution is merged and made public shortly after.
## Pull request format
Name your pull request using the following format:
```
```
| Field | Description | Examples |
| ------------------ | ------------------------------------- | ----------------------- |
| **Language** | Two-letter language code in uppercase | `FR`, `EN`, `DE` |
| **Type of change** | The kind of update | `Add`, `Update`, `Fix` |
| **Directory name** | Name of the guide folder | `Change email password` |
**Example:** `FR Update Change email password`
You can add a product shortcut if relevant.
Your pull request must target the `develop` branch only. Pull requests to other branches will not be accepted.
## Before you submit
Review the following checklist before opening a pull request:
* Read the [OVHcloud Documentation readme](https://github.com/ovh/docs/blob/develop/readme.md)
* Edit at least the `en-gb` version of a guide
* Edit the `fr-fr` version as well if you are a French speaker
* Edit all language files if you are doing a fix or minor update (recommended, not mandatory)
* Keep pull requests small and focused where possible
* Test every step you are documenting
* Use descriptive commit messages
* Resize images that exceed 1400px in width
* Blur or remove any sensitive information from text and images (IPs, user IDs, private URLs)
## Creating a new guide
When creating a new guide, you must complete two additional steps beyond writing the guide content itself.
### Create a meta.yaml file
Every new guide folder must contain a `meta.yaml` file with two mandatory fields:
```yaml theme={null}
id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
full_slug: product-category-guide-name
```
| Field | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | A UUID4 unique identifier. Generate one at [uuidgenerator.net/version4](https://www.uuidgenerator.net/version4) or with the `uuidgen` terminal command. |
| `full_slug` | The slug for the guide's URL. Prefix it based on related existing guides and keep it short with only important keywords. |
### Update the index
Add your guide to the [index.md](https://github.com/ovh/docs/blob/develop/pages/index.md) file so it appears in the correct category on the documentation website.
If the category does not exist yet, you can create it — but you must also generate its translations across all seven `index-translations..md` files.
## Screenshots guidelines
Use the English version of the OVHcloud Control Panel or any other interface when taking screenshots, whenever possible.
Follow these rules for all screenshots:
* **Format:** Save all screenshots as `.png` files
* **Language:** Prefer the English UI
* **Highlights:** Use OrangeSunrise (`#ff9803` — RGBA: 255, 152, 3, 1) to highlight any information
* **Sensitive data:** Blur or remove any private information such as IPs, user IDs, or private URLs
## Pull request types
The following pull request types are supported:
* **New guide(s)** — requires a `meta.yaml` file and an index update
* **Update of existing guide(s)**
* **Fix**
* **Optimization**
* **Index categories update**
* **Deletion of guide(s)** — contact the OVHcloud Guides Team, as redirections may be needed
## Translations
Indicate in your pull request how translations were handled:
* OVHcloud integrated translation LLM
* Systran
* Another tool (specify which)
* No translation required
## License
When you submit a contribution to OVHcloud documentation, you accept the terms of the [LICENSE](https://github.com/ovh/docs/blob/develop/LICENSE) file.