mirror of
https://github.com/kernelkit/infix.git
synced 2026-07-22 01:13:00 +02:00
Joachim Wiberg
fdf1aaebcc
The Python tool 'mike'[1] helps manage multiple versions of MkDocs-powered documentation. Only required when building the kernelkit.org site docs! For each new tag, that steps year or month, a new version of is created of the documentation, in a separate sub-directory on the gh-pages branch. Strategy - Version Grouping with Early Publishing: - Extract YEAR.MONTH from tag E.g., v25.06.0-beta1, v25.06.0-rc1, v25.06.0, v25.06.1 → become version 25.06 - From first pre-release onwards: - v25.06.0-beta1 → creates docs version 25.06 - v25.06.0-rc1 → updates docs version 25.06 - v25.06.0 (GA) → updates docs version 25.06 - v25.06.1 (patch) → updates docs version 25.06 - New major/minor series: - v25.07.0-beta1 → creates new docs version 25.07 Benefits: - Users get docs as soon as beta/rc is available - Patches update existing docs (logical since patches rarely change docs significantly) - Clean version grouping by YEAR.MONTH - Mike handles create vs update automatically [1]: https://github.com/jimporter/mike Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
120 lines
3.0 KiB
YAML
120 lines
3.0 KiB
YAML
site_name: User's Guide
|
|
site_description: Infix Documentation
|
|
site_url: https://kernelkit.github.io/infix/
|
|
repo_url: https://github.com/kernelkit/infix/
|
|
repo_name: kernelkit/infix
|
|
site_author: The KernelKit Team
|
|
copyright: Copyright © 2022-2025 The KernelKit Authors
|
|
docs_dir: doc/
|
|
edit_uri: edit/master/doc/
|
|
|
|
exclude_docs: |
|
|
ChangeLog.md
|
|
cli/README.md
|
|
README.md
|
|
TODO.org
|
|
|
|
nav:
|
|
- About: index.md
|
|
- Introduction: introduction.md
|
|
- Network Configuration: networking.md
|
|
- System Configuration: system.md
|
|
- System Management: management.md
|
|
- System Upgrade: upgrade.md
|
|
- CLI:
|
|
- Introduction : cli/introduction.md
|
|
- Configuration: cli/configure.md
|
|
- Keybindings: cli/keybindings.md
|
|
- Network Calculator: cli/netcalc.md
|
|
- Network Monitoring: cli/tcpdump.md
|
|
- Quickstart Guide: cli/quick.md
|
|
- Text Edítor: cli/text-editor.md
|
|
- Upgrading: cli/upgrade.md
|
|
- In-Depth:
|
|
- Boot Procedure: boot.md
|
|
- DHCP Server: dhcp.md
|
|
- Docker Containers: container.md
|
|
- Hardware Info & Status: hardware.md
|
|
- Network Discovery: discovery.md
|
|
- Scripting Infix: scripting.md
|
|
- Tunneling (L2/L3): tunnels.md
|
|
- Quality of Service: qos.md
|
|
- RMON Counters: eth-counters.md
|
|
- Syslog Support: syslog.md
|
|
- Virtual Environments: virtual.md
|
|
- Wireless LAN (WiFi): wifi.md
|
|
- For Developers:
|
|
- Branding & Releases: branding.md
|
|
- Developer's Guide: developers-guide.md
|
|
- Developing with Buildroot: override-package.md
|
|
- Netboot HowTo: netboot.md
|
|
- Regression Testing: testing.md
|
|
- Test System Architechture: test-arch.md
|
|
- Vital Product Data (VPD): vpd.md
|
|
- Origin & Licensing: license.md
|
|
|
|
theme:
|
|
logo: jack.png
|
|
name: material
|
|
features:
|
|
- toc.follow
|
|
# - toc.integrate
|
|
- navigation.path
|
|
# - navigation.prune
|
|
- navigation.instant
|
|
# - navigation.instant.progress
|
|
- navigation.tracking
|
|
# - navigation.tabs
|
|
# - navigation.sections
|
|
# - navigation.expand
|
|
# - navigation.top
|
|
# - navigation.footer
|
|
- search.highlight
|
|
- search.share
|
|
# - content.action.edit
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.footnote.tooltips
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: orange
|
|
accent: orange
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: black
|
|
accent: orange
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- footnotes
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
|
|
plugins:
|
|
- search
|
|
- callouts
|
|
- mike
|
|
|
|
extra:
|
|
generator: false
|
|
homepage: https://kernelkit.org/
|
|
version:
|
|
provider: mike
|