From 60c726826331368e540ab36d2bba5478808aa4b6 Mon Sep 17 00:00:00 2001 From: Andrew Burden Date: Fri, 15 May 2026 15:43:54 +0200 Subject: [PATCH] Replace mkdocs-awesome-pages-plugin with mkdocs-awesome-nav The awesome-pages plugin has been superseded by awesome-nav. This change: - Renames .pages files to .nav.yml (file format is identical) - Updates mkdocs.yml to use awesome-nav plugin - Updates Makefile and netlify.toml dependencies - Updates documentation references Assisted-by: Claude Signed-off-by: Andrew Burden --- Makefile | 2 +- README.md | 4 ++-- docs/{.pages => .nav.yml} | 0 docs/cluster_admin/{.pages => .nav.yml} | 0 docs/compute/{.pages => .nav.yml} | 0 docs/debug_virt_stack/{.pages => .nav.yml} | 0 docs/network/{.pages => .nav.yml} | 0 docs/network/hotplug/{.pages => .nav.yml} | 0 docs/storage/{.pages => .nav.yml} | 0 docs/user_workloads/{.pages => .nav.yml} | 0 mkdocs.yml | 2 +- netlify.toml | 2 +- 12 files changed, 5 insertions(+), 5 deletions(-) rename docs/{.pages => .nav.yml} (100%) rename docs/cluster_admin/{.pages => .nav.yml} (100%) rename docs/compute/{.pages => .nav.yml} (100%) rename docs/debug_virt_stack/{.pages => .nav.yml} (100%) rename docs/network/{.pages => .nav.yml} (100%) rename docs/network/hotplug/{.pages => .nav.yml} (100%) rename docs/storage/{.pages => .nav.yml} (100%) rename docs/user_workloads/{.pages => .nav.yml} (100%) diff --git a/Makefile b/Makefile index 10d091239..d8ba1ef83 100644 --- a/Makefile +++ b/Makefile @@ -114,7 +114,7 @@ build: envvar @echo "${GREEN}Makefile: Build mkdocs site${RESET}" $(PYTHON) -m venv /tmp/venv . /tmp/venv/bin/activate - $(PIP) install mkdocs mkdocs-awesome-pages-plugin mkdocs-htmlproofer-plugin mkdocs-material mkdocs-redirects + $(PIP) install mkdocs mkdocs-awesome-nav mkdocs-htmlproofer-plugin mkdocs-material mkdocs-redirects @echo @echo '*** BEGIN cat mkdocs.yml ***' @cat mkdocs.yml diff --git a/README.md b/README.md index 3a1c1f2e6..868e2ad1c 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ We more than welcome contributions to KubeVirt documentation. Please reach out i You can find the markdown that powers the user guide in `./docs`, most commits are to that area. -We use [mkdocs](https://www.mkdocs.org/) markdown engine with [mkdocs-awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/) plugin +We use [mkdocs](https://www.mkdocs.org/) markdown engine with [mkdocs-awesome-nav](https://github.com/lukasgeiter/mkdocs-awesome-nav/) plugin - mkdocs config file - - Each subdirectory of `./docs` contains a `.pages` file. We use this to force the ordering of pages. Alphabetical ordering is not ideal for technical documentation. + - Each subdirectory of `./docs` contains a `.nav.yml` file. We use this to force the ordering of pages. Alphabetical ordering is not ideal for technical documentation. #### Sign your commits diff --git a/docs/.pages b/docs/.nav.yml similarity index 100% rename from docs/.pages rename to docs/.nav.yml diff --git a/docs/cluster_admin/.pages b/docs/cluster_admin/.nav.yml similarity index 100% rename from docs/cluster_admin/.pages rename to docs/cluster_admin/.nav.yml diff --git a/docs/compute/.pages b/docs/compute/.nav.yml similarity index 100% rename from docs/compute/.pages rename to docs/compute/.nav.yml diff --git a/docs/debug_virt_stack/.pages b/docs/debug_virt_stack/.nav.yml similarity index 100% rename from docs/debug_virt_stack/.pages rename to docs/debug_virt_stack/.nav.yml diff --git a/docs/network/.pages b/docs/network/.nav.yml similarity index 100% rename from docs/network/.pages rename to docs/network/.nav.yml diff --git a/docs/network/hotplug/.pages b/docs/network/hotplug/.nav.yml similarity index 100% rename from docs/network/hotplug/.pages rename to docs/network/hotplug/.nav.yml diff --git a/docs/storage/.pages b/docs/storage/.nav.yml similarity index 100% rename from docs/storage/.pages rename to docs/storage/.nav.yml diff --git a/docs/user_workloads/.pages b/docs/user_workloads/.nav.yml similarity index 100% rename from docs/user_workloads/.pages rename to docs/user_workloads/.nav.yml diff --git a/mkdocs.yml b/mkdocs.yml index af5d92133..d02a65406 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,7 +7,7 @@ site_dir: site plugins: - search: separator: '[\s\-,:!=\[\]\(\)"/]+|\.(?!\d)' - - awesome-pages + - awesome-nav - redirects: redirect_maps: 'operations/customize_components.md': 'cluster_admin/customize_components.md' diff --git a/netlify.toml b/netlify.toml index ddc508bda..3f3ade83c 100644 --- a/netlify.toml +++ b/netlify.toml @@ -2,7 +2,7 @@ publish = "./site" command = """ pip install --upgrade pip; -pip install mkdocs mkdocs-awesome-pages-plugin mkdocs-material mkdocs-redirects; +pip install mkdocs mkdocs-awesome-nav mkdocs-material mkdocs-redirects; sed -i 's|site_url: https://kubevirt.io/docs|site_url: https://kubevirt.io/|' /opt/build/repo/mkdocs.yml; sed -i 's/docs_dir: docs/docs_dir:/' /opt/build/repo/mkdocs.yml; echo '*** BEGIN /opt/build/repo/mkdocs.yml ***';