Who can contribute
Community contributors
Fork the repository, write your changes, then open a pull request from your fork to the
ovh/docs repo.OVHcloud employees
Do not use a fork. Contact the OVHcloud Guides Team to be granted write access to the repository directly.
Contribution workflow
Fork the repository
Fork the ovh/docs repository to your own GitHub account.
Write your changes
Make your edits on your fork. Follow the 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.
Open a pull request
Create a pull request 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.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 |
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
- Edit at least the
en-gbversion of a guide - Edit the
fr-frversion 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 ameta.yaml file with two mandatory fields:
| Field | Description |
|---|---|
id | A UUID4 unique identifier. Generate one at 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 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 sevenindex-translations.<language>.md files.
Screenshots guidelines
Use the English version of the OVHcloud Control Panel or any other interface when taking screenshots, whenever possible.
- Format: Save all screenshots as
.pngfiles - 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.yamlfile 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