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

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

parent 84b7ddb7
No related branches found
No related tags found
No related merge requests found
......@@ -863,9 +863,11 @@
<h2 id="system-and-structure">System and Structure</h2>
<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>
<h3 id="how-it-works">How it works?</h3>
<p>There are 2 ways to upgrade documentation published on <a href="https://ocf.etsi.org/documentation/" title="OCF Documentation">OCF Documentation</a>:
* Push any change on <strong>develop</strong> branch will force update of <strong>develop</strong> version on the <a href="https://ocf.etsi.org/documentation/" title="OCF Documentation">OCF Documentation</a> website;
* Create a tag, this will create a version with tag name on the <a href="https://ocf.etsi.org/documentation/" title="OCF Documentation">OCF Documentation</a> website.</p>
<p>There are 2 ways to upgrade documentation published on the <a href="https://ocf.etsi.org/documentation/" title="OCF Documentation">OCF Documentation</a> website:</p>
<ul>
<li>Push any change on <strong>develop</strong> branch will force update of the <strong>develop</strong> version on the <a href="https://ocf.etsi.org/documentation/" title="OCF Documentation">OCF Documentation</a> website;</li>
<li>Create a tag, this will create a version with the tag name on the <a href="https://ocf.etsi.org/documentation/" title="OCF Documentation">OCF Documentation</a> website.</li>
</ul>
<h3 id="branches">Branches</h3>
<p>This documentation repository has 2 protected branches:</p>
<ul>
......@@ -887,11 +889,11 @@
- FAQ: ./FAQ.md
</code></pre>
<p>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 <strong>how to test</strong> OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked;
* Contribute: details about how to contribute code and docs;
* FAQ.</p>
* 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 <strong>how to test</strong> OpenCAPIF, and test plan developed to ensure the code has all implemented functionality checked;
* Contribute: details about how to contribute code and docs;
* FAQ.</p>
<h3 id="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>
<h2 id="getting-started">Getting Started</h2>
......@@ -924,9 +926,11 @@ python -m pip install mike
<li>Perform the development of functionality on <code>capif</code> code repository;</li>
<li>Create an issue on <a href="https://labs.etsi.org/rep/ocf/documentation/-/issues">GitLab</a>;</li>
<li>Create a new branch with source from <strong>develop</strong>;</li>
<li>Update documentation:</li>
<li><strong><em>Remember to update index.md with new functionalities for the latest version</em></strong>;</li>
<li>New test plan is defined? <strong>Update test plan documentation</strong></li>
<li>Update documentation:<ol>
<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>
</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>
......
Source diff could not be displayed: it is too large. Options to address this: view the blob.
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