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

Deployed aea67a7c to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent d7bbd467
No related branches found
No related tags found
No related merge requests found
...@@ -917,26 +917,24 @@ python -m pip install mike ...@@ -917,26 +917,24 @@ 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><code class="language-bash">mkdocs serve <pre><code class="language-bash">mkdocs serve
</code></pre> </code></pre>
<p>5) Document (and commit - <em>follow the steps in the section below before committing</em>)! 😊</p> <p>5) Document! 😊</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>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>
</blockquote> </blockquote>
<h3 id="add-documentation-during-development">Add Documentation During Development</h3> <h3 id="add-documentation-during-development">Add Documentation During Development</h3>
<p>To update the documentation properly during development, follow those steps:</p> <p>To update the documentation properly during development, follow those additional steps:</p>
<ol> <ol>
<li>Create an issue on the documentation <a href="https://labs.etsi.org/rep/ocf/documentation/-/issues">GitLab</a> repository;</li> <li>Create an issue on the documentation <a href="https://labs.etsi.org/rep/ocf/documentation/-/issues">GitLab</a> repository;</li>
<li>Create a new branch with the <strong>develop</strong> branch as a source;</li> <li>Create a new branch with the <strong>develop</strong> branch as a source;</li>
<li>Update the documentation:<ol> <li>Update the documentation and any relevant parts (ie: the <code>index.md</code> with new functionalities for the latest version<strong> or if a new test plan is defined, remember to </strong>update the test plan documentation**);</li>
<li><strong>Remember to update index.md with new functionalities for the latest version</strong>;</li> <li>Check if errors are not being produced by <code>mkdocs</code> <a href="#getting-started">locally</a>;</li>
<li>If a new test plan is defined, remember to <strong>update the test plan documentation</strong></li> <li>Commit and push changes to the new branch;</li>
</ol>
</li>
<li>Check if errors are being produced by <code>mkdocs</code> <a href="#getting-started">locally</a>;</li>
<li>Push changes to branch;</li>
<li>Create a merge/pull request;</li> <li>Create a merge/pull request;</li>
<li>Send the request to review to at least one TSC Member for approval.</li> <li>Send the request for review and approval to at least one <strong>TSC Member</strong>.</li>
</ol> </ol>
<blockquote>
<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>
<h3 id="release-a-new-version-of-the-documentation">Release a New Version of the Documentation</h3> <h3 id="release-a-new-version-of-the-documentation">Release a New Version of the Documentation</h3>
<p>When <strong>OpenCAPIF</strong> code repository is ready for a new release, we need to follow these steps (made by a <strong>TSC Member</strong>):</p> <p>When <strong>OpenCAPIF</strong> code repository is ready for a new release, we need to follow these steps (made by a <strong>TSC Member</strong>):</p>
<ol> <ol>
......
This diff is collapsed.
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