Merge pull request #7687 from ovh/YC-Readme-PR-template

Readme update + Pull Request template creation

Author: Y0Coss

pull_request_template.md

@@ -0,0 +1,46 @@
+<!--
+Hello 👋
+Thank you for submitting a Pull Request.
+
+For Work In Progress Pull Requests, please use the Draft PR feature, see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. As long as your Pull Request is a draft, the OVHcloud Guides Team will not start proofreading it.
+
+For a timely review/response, please avoid force-pushing additional commits if your PR already received reviews or comments.
+
+DO NOT USE a fork if you are an OVHcloud employee. Instead, please contact the OVHcloud Guides Team so to be granted /write access to this repository.
+
+Feel free to apply labels on your Pull Request, selecting them from the list to your right.
+
+Before submitting a Pull Request, please ensure you have:
+
+- 📖 Read the OVHcloud Documentation readme: https://github.com/ovh/docs/blob/develop/readme.md
+- 🇬🇧 Edited (at least) the en-gb version of a guide.
+- 🇫🇷 Edited also the fr-fr version if you are a French speaker.
+- 🌐 Edited all the files if you're doing a fix or a minor update (this is not mandatory but recommended).
+- 👷‍♀️ Created a small PR, if applicable.
+- ✅ Tested every step you're documenting.
+- 📝 Used descriptive commit messages.
+- 📐 Resized images which width exceeds 1400px
+- 📝 Edited or blurred any sensitive/private information from your text and images (IPs, user IDs, private URLs, etc.)
+-->
+
+## What type of Pull Request is this?
+
+<!-- Check [X] all applicable: -->
+- [ ] New guide(s) <!-- You need to create a meta.yaml file and edit the index: https://github.com/ovh/docs/blob/develop/pages/index.md -->
+- [ ] Update of existing guide(s)
+- [ ] Fix
+- [ ] Optimization
+- [ ] Index categories update
+- [ ] Deletion of guide(s) <!-- redirections may be needed, contact the OVHcloud Guides Team -->
+
+## Description
+
+<!-- Please provide a short description for your Pull Request, including (if applicable) a ticket reference (no internal URL!) or GitHub issue -->
+
+## Mandatory information
+
+<!-- Check the following when applicable: -->
+- [ ] This Pull Request can be merged as soon as possible.
+- [ ] This Pull Request shouldn't be merged before (indicate a date): YYYY-MM-DD
+
+- [ ] This Pull Request content should be replicated for the US OVHcloud documentation <!-- https://support.us.ovhcloud.com/hc/en-us) -->

readme.md

@@ -1,27 +1,40 @@
 # OVHcloud Documentation
 
-This repository contains all the public documentation available about OVHcloud products, in all languages. A good way to find answers to some "how to" questions about OVHcloud products.
+This repository contains all the public documentation available about OVHcloud products, in 7 languages. A good way to find answers to some "how to" questions about OVHcloud products.
 
-A web version also exists [here](https://help.ovhcloud.com/csm). This website and this repo are synced.
+A web version also exists [here](https://help.ovhcloud.com/csm). This website and this repository are synced.
 
 This project is under active development, and new guides are added or updated on a daily basis.
 
 ## Contributing
 
 We will be happy to take a look at your contributions. You can contribute to this project by updating some existing guides, completing them or creating new ones.
 
-A good way to easily get started with contributions is [to fork the ovh/docs repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo), write your changes on your fork then [create a pull request (PR)](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 ovh/docs repo. Your PR must be done on the "develop" branch.
+A good way to easily get started with contributions is [to fork the ovh/docs repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo), write your changes on your fork then [create a pull request (PR)](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 ovh/docs repo. 
+
+Your PR must be done on the `develop` branch.
 
 Our guides editing team will then review your contribution and choose to edit, validate or reject it.
 
+**If you are an OVHcloud employee, do not use a fork**. Instead, please contact the OVHcloud Guides Team so to be granted /write access to this repository.
+
 Please take into consideration the following guidelines :
 
 ### Content
 
 * Verify and test every action you describe: do not write about anything you cannot test by yourself.
-* Please give us explanations regarding your contribution in the comments section of your PR.
+* Please provide us with a description regarding your contribution.
 * All OVHcloud guides are built with the same layout and structure, please use them as a template to write your own contributions.
 
+#### New guide
+
+When creating a new guide, you must also do the following:
+
+* Create a `meta.yaml` file in your new guide's folder. This file must contain the 2 following fields:
+    * `id:`: generate a UUID4 unique identifier using either <https://www.uuidgenerator.net/version4> or the `uuidgen` command from a terminal.
+    * `full_slug:`: this will generate the slug component of the future guide's URL. Please rely on the already existing and related guides so to prefix your ``full_slug` accordingly. Also only include important keywords and try keeping it short.
+* Update the [index](https://github.com/ovh/docs/blob/develop/pages/index.md) so that your new guide is listed in its right category. If that category doesn't exist yet, you can create it but you will also have to generate its translations in the 7 `index-translations.<language>.md` files.
+
 ### Screenshots
 
 * Prefer to use the English version of the OVHcloud Control Panel or any other interface when taking screenshots.