Skip to content
Snippets Groups Projects
Commit e2c89bfd authored by Julien Satti's avatar Julien Satti :sparkles:
Browse files

Update file documenting.md

parent 8fc08fcb
No related branches found
No related tags found
1 merge request!16Align documentation contribution guidelines
...@@ -114,7 +114,7 @@ To update the documentation properly during development, follow those additional ...@@ -114,7 +114,7 @@ To update the documentation properly during development, follow those additional
3. Update the documentation and any relevant parts (ie: the ``index.md`` with new functionalities for the latest version); 3. Update the documentation and any relevant parts (ie: the ``index.md`` with new functionalities for the latest version);
4. Check if errors are not being produced by ``mkdocs`` [locally](#getting-started); 4. Check if errors are not being produced by ``mkdocs`` [locally](#getting-started);
5. Commit and push changes to the new branch; 5. Commit and push changes to the new branch;
6. Create a PR request towards **develop**; 6. Create a MR request towards **develop**;
7. Send the request for review and approval to at least one **TSC Member**. 7. Send the request for review and approval to at least one **TSC Member**.
> The documentation website supports branches, so your accepted changes will be reflected to the **develop** branch which then becomes the **release** branch after each corresponding cycle. > The documentation website supports branches, so your accepted changes will be reflected to the **develop** branch which then becomes the **release** branch after each corresponding cycle.
...@@ -123,7 +123,7 @@ To update the documentation properly during development, follow those additional ...@@ -123,7 +123,7 @@ To update the documentation properly during development, follow those additional
When **OpenSlice** code repository is ready for a new release, we need to follow these steps (made by a **TSC Member**): When **OpenSlice** code repository is ready for a new release, we need to follow these steps (made by a **TSC Member**):
1. Create a PR from **develop** towards **main**; 1. Create a MR from **develop** towards **main**;
2. When **develop** is merged to **main**... then **create a tag with the released version** scheme... and you're done! 2. When **develop** is merged to **main**... then **create a tag with the released version** scheme... and you're done!
[OSL Web]: https://osl.etsi.org/ "OSL Web" [OSL Web]: https://osl.etsi.org/ "OSL Web"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment