Deployed 45b10439 to develop in public with MkDocs 1.6.1 and mike 2.1.3

<h1 id="documenting">Documenting</h1>

<p>OpenSlice's documentation runs on <a href="https://www.mkdocs.org/">MkDocs</a>.</p>

<blockquote>

<p>This page is a WIP. Updates are ongoing.</p>

</blockquote>

<h2 id="eligibility">Eligibility</h2>

<p>Documenting OpenSlice is limited to active contributors. So, if you:</p>

<ol>

<p><a href="https://www.mkdocs.org/">MkDocs</a> is a fast and simple static site generator that's geared towards building project documentation. Documentation source files are written in <code>Markdown</code>, and configured with a single <code>YAML</code> configuration file. Start by reading the <a href="https://www.mkdocs.org/getting-started/">introductory tutorial</a>, then check the <a href="https://www.mkdocs.org/user-guide/">User Guide</a> for more information.</p>

<h2 id="getting-started">Getting Started</h2>

<p>To contribute to OpenSlice's documentation, you need to follow those easy steps:</p>

<ol>

<li>

<p>Clone the <a href="https://labs.etsi.org/rep/osl/documentation">repository</a> with:</p>

<p><code>bash

git clone https://labs.etsi.org/rep/osl/documentation.git</code></p>

</li>

<li>

<p>Checkout the desired branch (don't forget to select one or make one!):</p>

<p><code>bash

git checkout develop #[or another branch]</code></p>

</li>

<li>

<p>Document (and commit)! 😊</p>

</li>

</ol>

<p>1) Clone the <a href="https://labs.etsi.org/rep/osl/documentation">Documentation repository</a> with:</p>

<pre><code class="language-bash">git clone https://labs.etsi.org/rep/osl/documentation.git

</code></pre>

<p>2) Checkout the develop branch (incoming contributions are only accepted to the develop branch):</p>

<pre><code class="language-bash">cd ./documentation

git checkout develop

</code></pre>

<p>3) Setup a local mkdocs server, using a virtual environment</p>

<pre><code class="language-bash">python3 -m venv venv

source venv/bin/activate

 python -m pip install mkdocs

 python -m pip install mkdocs-material

 python -m pip install mike

</code></pre>

<p>4) Wait for all downloads to finish and start the mkdocs server</p>

<pre><code class="language-bash">mkdocs serve

</code></pre>

<p>5) Document (and commit)! 😊</p>

<p>Before committing, you should make sure that the local mkdcocs server's terminal is not producing any INFO/WARNING message regarding your contributions.</p>

<blockquote>

<p>The documentation website supports branches, so your changes will be reflected in the corresponding branch.</p>

<p>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.</p>

</blockquote>