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

Tweak documenting process

parent 68871c31
No related branches found
No related tags found
No related merge requests found
Pipeline #10990 passed
...@@ -91,25 +91,23 @@ python -m pip install mike ...@@ -91,25 +91,23 @@ python -m pip install mike
mkdocs serve mkdocs serve
``` ```
5) Document (and commit - *follow the steps in the section below before committing*)! 😊 5) Document! 😊
> You should always make sure that the local *MkDocs* server terminal is not producing any `INFO`/``WARNING`` messages regarding your contributions. > You should always make sure that the local *MkDocs* server terminal is not producing any `INFO`/``WARNING`` messages regarding your contributions.
> The documentation website supports branches, so your accepted changes will be reflected to the **develop** branch which becomes the **release** branch after each corresponding cycle.
### Add Documentation During Development ### Add Documentation During Development
To update the documentation properly during development, follow those steps: To update the documentation properly during development, follow those additional steps:
1. Create an issue on the documentation [GitLab](https://labs.etsi.org/rep/ocf/documentation/-/issues) repository; 1. Create an issue on the documentation [GitLab](https://labs.etsi.org/rep/ocf/documentation/-/issues) repository;
2. Create a new branch with the **develop** branch as a source; 2. Create a new branch with the **develop** branch as a source;
3. Update the documentation: 3. Update the documentation and any relevant parts (ie: the ``index.md`` with new functionalities for the latest version** or if a new test plan is defined, remember to **update the test plan documentation**);
1. **Remember to update index.md with new functionalities for the latest version**; 4. Check if errors are not being produced by ``mkdocs`` [locally](#getting-started);
2. If a new test plan is defined, remember to **update the test plan documentation** 5. Commit and push changes to the new branch;
4. Check if errors are being produced by ``mkdocs`` [locally](#getting-started);
5. Push changes to branch;
6. Create a merge/pull request; 6. Create a merge/pull request;
7. Send the request to review to at least one TSC Member for approval. 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 becomes the **release** branch after each corresponding cycle.
### Release a New Version of the Documentation ### Release a New Version of the Documentation
......
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