<p>As you can see here, we have at the time of writing this page, 5 main sections:
<p>As you can see here, we have at the time of writing this page, 5 main sections:</p>
* Overview: here we placed high-level information like version changelog, some initial scripts, ...
<ul>
* Getting Started: this section contains a simple way to start working with the project;
<li>Overview: here we placed high-level information like version changelog, some initial scripts, ...;</li>
* Testing: detailed information of <strong>how to test</strong> OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked;
<li>Getting Started: this section contains a simple way to start working with the project;</li>
* Contribute: details about how to contribute code and docs;
<li>Testing: detailed information of <strong>how to test</strong> OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked;</li>
* FAQ.</p>
<li>Contribute: details about how to contribute code and docs;</li>
<li>FAQ.</li>
</ul>
<h3id="main-page">Main Page</h3>
<h3id="main-page">Main Page</h3>
<p>The page shown first is at <strong>doc/index.md</strong>. That page should be updated with the latest changes of OpenCAPIF, also including the version.</p>
<p>The page shown first is at <strong>doc/index.md</strong>. That page should be updated with the latest changes of OpenCAPIF, also including the version.</p>
<h2id="getting-started">Getting Started</h2>
<h2id="getting-started">Getting Started</h2>
...
@@ -915,18 +917,17 @@ python -m pip install mike
...
@@ -915,18 +917,17 @@ python -m pip install mike
<p>4) Wait for all downloads to finish and start the local <code>mkdocs</code> server:</p>
<p>4) Wait for all downloads to finish and start the local <code>mkdocs</code> server:</p>
<pre><codeclass="language-bash">mkdocs serve
<pre><codeclass="language-bash">mkdocs serve
</code></pre>
</code></pre>
<p>5) Document (and commit)! 😊</p>
<p>5) Document (and commit - <em>follow the steps in the section below before committing</em>)! 😊</p>
<p>Before committing, you should make sure that the local <em>MkDocs</em> server terminal is not producing any <code>INFO</code>/<code>WARNING</code> messages regarding your contributions.</p>
<blockquote>
<blockquote>
<p>You should always make sure that the local <em>MkDocs</em> server terminal is not producing any <code>INFO</code>/<code>WARNING</code> messages regarding your contributions.</p>
<p>The documentation website supports branches, so your accepted changes will be reflected to the <strong>develop</strong> branch which becomes the <strong>release</strong> branch after each corresponding cycle.</p>
<p>The documentation website supports branches, so your accepted changes will be reflected to the <strong>develop</strong> branch which becomes the <strong>release</strong> branch after each corresponding cycle.</p>
</blockquote>
</blockquote>
<h3id="add-documentation-during-development">Add Documentation During Development</h3>
<h3id="add-documentation-during-development">Add Documentation During Development</h3>
<p>To update the documentation during development, follow those steps:</p>
<p>To update the documentation properly during development, follow those steps:</p>
<ol>
<ol>
<li>Perform the development of functionality on <code>capif</code> code repository;</li>
<li>Create an issue on the documentation <ahref="https://labs.etsi.org/rep/ocf/documentation/-/issues">GitLab</a> repository;</li>
<li>Create an issue on <ahref="https://labs.etsi.org/rep/ocf/documentation/-/issues">GitLab</a>;</li>
<li>Create a new branch with the <strong>develop</strong> branch as a source;</li>
<li>Create a new branch with source from <strong>develop</strong>;</li>
<li>Update the documentation:<ol>
<li>Update documentation:<ol>
<li><strong>Remember to update index.md with new functionalities for the latest version</strong>;</li>
<li><strong>Remember to update index.md with new functionalities for the latest version</strong>;</li>
<li>If a new test plan is defined, remember to <strong>update the test plan documentation</strong></li>
<li>If a new test plan is defined, remember to <strong>update the test plan documentation</strong></li>