peter/infix
1
0
Fork 0
mirror of https://github.com/kernelkit/infix.git synced 2026-07-31 21:13:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Deployed cf4a29da to dev with MkDocs 1.6.1 and mike 2.1.3

Browse Source
This commit is contained in:
github-actions[bot]
2025-07-30 13:00:01 +00:00
parent 16ad2329b5
commit ed0c87c1a9
4 changed files with 81 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/developers-guide/index.html
+44 -6
View File
@@ -1342,6 +1342,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
<span class="md-ellipsis">
Documentation
</span>
</a>
</li>
</ul>
@@ -1760,6 +1769,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
<span class="md-ellipsis">
Documentation
</span>
</a>
</li>
</ul>
@@ -2034,6 +2052,26 @@ and services are required on your system:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>$<span class="w"> </span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>python3-graphviz<span class="w"> </span>ruby-asciidoctor-pdf
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>..
</code></pre></div>
<h3 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">&para;</a></h3>
<p>The documentation is written in Markdown, with GitHub extensions, and
published using <a href="https://squidfunk.github.io/mkdocs-material/">MkDocs, material theme</a>. This means some features
require MkDocs <em>hinting</em> which may not render fully when previewing on
GitHub -- this is OK.</p>
<p>MkDocs is packaged and available to install via <code>apt</code>, but not all of
the plugins and extensions we rely on are available, so instead we do
recommend using <code>pipx</code> to install the necessary tooling:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>$<span class="w"> </span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>pipx
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>$<span class="w"> </span>pipx<span class="w"> </span>install<span class="w"> </span>mkdocs
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>$<span class="w"> </span>pipx<span class="w"> </span>inject<span class="w"> </span>mkdocs<span class="w"> </span>mkdocs-material<span class="w"> </span>pymdown-extensions<span class="w"> </span>mkdocs-callouts<span class="w"> </span>mike<span class="w"> </span>mkdocs-to-pdf
</code></pre></div>
<p>The last two packages, <code>mike</code> and <code>mkdocs-to-pdf</code>, are used for online
versioning and PDF generation by GitHub Actions, but since they are in
the <code>mkdocs.yml</code> file, everyone who wants to preview the documentation
have to install all the tooling.</p>
<p>Preview with:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>$ cd ~/src/infix/
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>$ mkdocs serve
</code></pre></div>
<h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link">&para;</a></h2>
<p>Developing with Infix is the same as <a href="https://buildroot.org/downloads/manual/manual.html#_developer_guide">developing with Buildroot</a>.
When working with a package, be it locally kept sources, or when using
@@ -2348,12 +2386,12 @@ fork, and then use GitHub to create a <em>Pull Reqeuest</em>.</p>
<li><a href="https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow">Deactivate the Actions</a> you don't want in your fork</li>
<li>Please read the <a href="https://github.com/kernelkit/infix/blob/main/.github/CONTRIBUTING.md">Contributing Guidelines</a> as well!</li>
</ol>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>~/Projects
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/YOUR_USER_NAME/infix.git
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>...
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>infix/
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>$<span class="w"> </span>git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>...
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>~/Projects
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/YOUR_USER_NAME/infix.git
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>...
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>infix/
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a>$<span class="w"> </span>git<span class="w"> </span>submodule<span class="w"> </span>update<span class="w"> </span>--init
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a>...
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
dev/search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
dev/sitemap.xml
+36 -36
View File
@@ -2,146 +2,146 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://kernelkit.github.io/infix/dev/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/boot/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/branding/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/container/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/developers-guide/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/dhcp/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/discovery/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/eth-counters/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/hardware/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/license/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/management/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/netboot/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/networking/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/override-package/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/qos/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-prod/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-restconf/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-sysrepocfg/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/syslog/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/system/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/test-arch/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/testing/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/tunnels/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/upgrade/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/virtual/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/vpd/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/wifi/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/configure/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/introduction/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/keybindings/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/netcalc/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/quick/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/tcpdump/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/text-editor/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/upgrade/</loc>
<lastmod>2025-07-29</lastmod>
<lastmod>2025-07-30</lastmod>
</url>
</urlset>
dev/sitemap.xml.gz
BIN
View File
Binary file not shown.