diff --git a/doc/contribute/documenting.md b/doc/contribute/documenting.md index 3a0e226fd187812135015883e8402c60ee781851..a408dc112c29cb6f58b09b8e059290dee1733204 100644 --- a/doc/contribute/documenting.md +++ b/doc/contribute/documenting.md @@ -16,16 +16,17 @@ Documenting OpenCAPIF is limited to active contributors. So, if you: ### How it works? -There are 2 ways to upgrade documentation published on [OCF Documentation]: -* Push any change on **develop** branch will force update of **develop** version on the [OCF Documentation] website; -* Create a tag, this will create a version with tag name on the [OCF Documentation] website. +There are 2 ways to upgrade documentation published on the [OCF Documentation] website: + + * Push any change on **develop** branch will force update of the **develop** version on the [OCF Documentation] website; + * Create a tag, this will create a version with the tag name on the [OCF Documentation] website. ### Branches This documentation repository has 2 protected branches: -* **main**: this branch will store the information stable; -* **develop**: any change uploaded on this branch will upgrade **develop** version of the documentation published on the [OCF Documentation] website. + * **main**: this branch will store the information stable; + * **develop**: any change uploaded on this branch will upgrade **develop** version of the documentation published on the [OCF Documentation] website. ### Structure @@ -46,11 +47,11 @@ nav: ``` As you can see here, we have at the time of writing this page, 5 main sections: -* Overview: here we placed high-level information like version changelog, some initial scripts, ... -* Getting Started: this section contains a simple way to start working with the project; -* Testing: detailed information of **how to test** OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked; -* Contribute: details about how to contribute code and docs; -* FAQ. + * Overview: here we placed high-level information like version changelog, some initial scripts, ... + * Getting Started: this section contains a simple way to start working with the project; + * Testing: detailed information of **how to test** OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked; + * Contribute: details about how to contribute code and docs; + * FAQ. ### Main Page @@ -103,8 +104,8 @@ To update the documentation during development, follow those steps: 2. Create an issue on [GitLab](https://labs.etsi.org/rep/ocf/documentation/-/issues); 3. Create a new branch with source from **develop**; 4. Update documentation: - 1. ***Remember to update index.md with new functionalities for the latest version***; - 2. New test plan is defined? **Update test plan documentation** + 1. **Remember to update index.md with new functionalities for the latest version**; + 2. If a new test plan is defined, remember to **update the test plan documentation** 5. Check if errors are being produced by ``mkdocs`` [locally](#getting-started); 6. Push changes to branch; 7. Create a merge/pull request;