From 78ea5452bb8cce1c347e40d3fd4d071dd326e23c Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Wed, 11 Jun 2025 11:45:49 +0300 Subject: [PATCH] docs: switch to just-the-docs theme --- docs/Gemfile | 3 +- docs/Gemfile.lock | 9 ++- docs/_config.yml | 16 +++- docs/_includes/header_custom.html | 30 ++++++++ docs/_includes/templates/addons.liquid | 75 ------------------- docs/_includes/templates/sidebar.liquid | 18 ----- docs/contributing/index.md | 3 +- docs/deployment/helm.md | 3 +- docs/deployment/image-variants.md | 3 +- docs/deployment/index.md | 3 +- docs/deployment/kustomize.md | 3 +- docs/deployment/metrics.md | 3 +- docs/deployment/operator.md | 3 +- docs/deployment/uninstallation.md | 3 +- docs/developer-guide/index.md | 3 +- docs/get-started/index.md | 3 +- docs/get-started/introduction.md | 3 +- docs/get-started/quick-start.md | 3 +- docs/reference/architecture.md | 3 +- docs/reference/e2e-configuration-reference.md | 3 +- docs/reference/feature-gates.md | 3 +- docs/reference/gc-commandline-reference.md | 3 +- docs/reference/index.md | 3 +- .../reference/master-commandline-reference.md | 3 +- .../master-configuration-reference.md | 3 +- .../node-feature-client-reference.md | 3 +- .../reference/plugin-commandline-reference.md | 3 +- .../topology-updater-commandline-reference.md | 3 +- ...opology-updater-configuration-reference.md | 3 +- docs/reference/versions.md | 3 +- .../reference/worker-commandline-reference.md | 3 +- .../worker-configuration-reference.md | 3 +- docs/usage/custom-resources.md | 3 +- docs/usage/customization-guide.md | 3 +- docs/usage/examples-and-demos.md | 3 +- docs/usage/features.md | 3 +- docs/usage/image-compatibility.md | 3 +- docs/usage/index.md | 3 +- docs/usage/kubectl-plugin.md | 3 +- docs/usage/nfd-gc.md | 3 +- docs/usage/nfd-master.md | 3 +- docs/usage/nfd-topology-updater.md | 3 +- docs/usage/nfd-worker.md | 3 +- docs/usage/using-labels.md | 3 +- 44 files changed, 129 insertions(+), 136 deletions(-) create mode 100644 docs/_includes/header_custom.html delete mode 100644 docs/_includes/templates/addons.liquid delete mode 100644 docs/_includes/templates/sidebar.liquid diff --git a/docs/Gemfile b/docs/Gemfile index 56f5bf8b94..e88818e445 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -4,7 +4,6 @@ source "https://rubygems.org" # The original dep would allow github-pages v209.x but not v210 or later. plugin 'bundler-override' require File.join(Bundler::Plugin.index.load_paths("bundler-override")[0], "bundler-override") rescue nil -override 'jekyll-rtd-theme', :drop => "github-pages" # Hello! This is where you manage which Jekyll version is used to run. # When you want to use a different version, change it below, save the @@ -37,4 +36,4 @@ gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform? gem "webrick", "~> 1.8" -gem 'jekyll-rtd-theme', '~> 2.0', '>= 2.0.10' +gem "just-the-docs" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 2848fe3fb9..dd6cfe2f92 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -168,7 +168,6 @@ GEM jekyll (>= 3.5, < 5.0) jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) rubyzip (>= 1.3.0, < 3.0) - jekyll-rtd-theme (2.0.10) jekyll-sass-converter (1.5.2) sass (~> 3.4) jekyll-seo-tag (2.8.0) @@ -225,6 +224,11 @@ GEM html-pipeline (~> 2.2) jekyll (>= 3.0, < 5.0) json (2.12.2) + just-the-docs (0.10.1) + jekyll (>= 3.8.5) + jekyll-include-cache + jekyll-seo-tag (>= 2.0) + rake (>= 12.3.1) kramdown (2.4.0) rexml kramdown-parser-gfm (1.1.0) @@ -253,6 +257,7 @@ GEM forwardable-extended (~> 2.6) public_suffix (5.1.1) racc (1.8.1) + rake (13.3.0) rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) @@ -290,7 +295,7 @@ DEPENDENCIES github-pages (~> 232) jekyll (~> 3.10.0) jekyll-github-metadata! - jekyll-rtd-theme (~> 2.0, >= 2.0.10) + just-the-docs tzinfo (~> 2.0) tzinfo-data wdm (~> 0.1.1) diff --git a/docs/_config.yml b/docs/_config.yml index b316920971..e46f3540cb 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -26,7 +26,7 @@ markdown: kramdown kramdown: toc_levels: 1..3 -theme: jekyll-rtd-theme +theme: just-the-docs # Exclude from processing. # The following items will not be processed, by default. Create a custom list @@ -59,3 +59,17 @@ release: master # Container image which to point to in the documentation container_image: gcr.io/k8s-staging-nfd/node-feature-discovery:master + +nav: + - title: Home + url: / + - title: Guides + url: /guides/ + - title: Foo + nav: + - title: v1.0 + url: https://yourdomain.com/docs/v1.0 + - title: v1.1 + url: https://yourdomain.com/docs/v1.1 + - title: Latest + url: https://yourdomain.com/docs/latest diff --git a/docs/_includes/header_custom.html b/docs/_includes/header_custom.html new file mode 100644 index 0000000000..beb0ebe3bf --- /dev/null +++ b/docs/_includes/header_custom.html @@ -0,0 +1,30 @@ +{% if site.display_version_list %} +
+ + +
+{% endif %} diff --git a/docs/_includes/templates/addons.liquid b/docs/_includes/templates/addons.liquid deleted file mode 100644 index a07cbfb7bc..0000000000 --- a/docs/_includes/templates/addons.liquid +++ /dev/null @@ -1,75 +0,0 @@ -
-
-
- {{ site.title }} -
-
- - {{ site.version }} - - -
-
-
- {% if site.display_version_list %} -
-
Versions
- - {% if jekyll.environment == "development" %} -
- {{ site.version }} -
- {% else %} - {% comment %} - Drop the last component from site.baseurl which is supposed to - be pointing to a subdirectory of the true site baseurl. - {% endcomment %} - {% assign spliturl = site.baseurl | split: "/" %} - {% assign last = spliturl.size | minus: 1 %} - {% assign baseurl = spliturl | slice: 0, last | join: "/" %} - - - - {% endif %} -
- {% endif %} -
-
{{ __.github | default: "GitHub" }}
-
- - - {{ __.homepage | default: "Homepage" }} - -
-
- - - {{ __.issues | default: "Issues" }} - -
-
- - - {{ __.download | default: "Download" }} - -
-
-
-
- This - Software - is under the terms of - {{ docs.license.name | default: "The Unlicense" }}. -
-
-
diff --git a/docs/_includes/templates/sidebar.liquid b/docs/_includes/templates/sidebar.liquid deleted file mode 100644 index 418283184f..0000000000 --- a/docs/_includes/templates/sidebar.liquid +++ /dev/null @@ -1,18 +0,0 @@ -
-
-
-
- - {{ site.title }} - -
- {{ site.release }} -
- -
-
- -
-
diff --git a/docs/contributing/index.md b/docs/contributing/index.md index f3cd4a3c18..151e9b9698 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -1,7 +1,8 @@ --- title: "Contributing" layout: default -sort: 6 +nav_order: 6 +has_children: true --- # Contributing diff --git a/docs/deployment/helm.md b/docs/deployment/helm.md index 9646316bb8..aa4865b0db 100644 --- a/docs/deployment/helm.md +++ b/docs/deployment/helm.md @@ -1,7 +1,8 @@ --- title: "Helm" +parent: "Deployment" layout: default -sort: 3 +nav_order: 3 --- # Deployment with Helm diff --git a/docs/deployment/image-variants.md b/docs/deployment/image-variants.md index 9705631352..83d3bc4d89 100644 --- a/docs/deployment/image-variants.md +++ b/docs/deployment/image-variants.md @@ -1,7 +1,8 @@ --- title: "Image variants" +parent: "Deployment" layout: default -sort: 1 +nav_order: 1 --- # Image variants diff --git a/docs/deployment/index.md b/docs/deployment/index.md index 85e525d9ff..c5b9900c5d 100644 --- a/docs/deployment/index.md +++ b/docs/deployment/index.md @@ -1,7 +1,8 @@ --- title: "Deployment" layout: default -sort: 2 +has_children: true +nav_order: 2 --- # Deployment diff --git a/docs/deployment/kustomize.md b/docs/deployment/kustomize.md index 37ea5729e1..ea9661a0e5 100644 --- a/docs/deployment/kustomize.md +++ b/docs/deployment/kustomize.md @@ -1,7 +1,8 @@ --- title: "Kustomize" +parent: "Deployment" layout: default -sort: 2 +nav_order: 2 --- # Deployment with Kustomize diff --git a/docs/deployment/metrics.md b/docs/deployment/metrics.md index d0edd59a75..a834026a17 100644 --- a/docs/deployment/metrics.md +++ b/docs/deployment/metrics.md @@ -1,7 +1,8 @@ --- title: "Metrics" +parent: "Deployment" layout: default -sort: 6 +nav_order: 6 --- # Metrics diff --git a/docs/deployment/operator.md b/docs/deployment/operator.md index eb4bf54df8..3dd0488281 100644 --- a/docs/deployment/operator.md +++ b/docs/deployment/operator.md @@ -1,7 +1,8 @@ --- title: "NFD Operator" +parent: "Deployment" layout: default -sort: 4 +nav_order: 4 --- # Deployment with NFD Operator diff --git a/docs/deployment/uninstallation.md b/docs/deployment/uninstallation.md index 22e9a6e9d9..93ae56432d 100644 --- a/docs/deployment/uninstallation.md +++ b/docs/deployment/uninstallation.md @@ -1,7 +1,8 @@ --- title: "Uninstallation" +parent: "Deployment" layout: default -sort: 5 +nav_order: 5 --- # Uninstallation diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md index 6f8d2ad61c..5a6818c1f6 100644 --- a/docs/developer-guide/index.md +++ b/docs/developer-guide/index.md @@ -1,7 +1,8 @@ --- title: "Developer guide" layout: default -sort: 5 +nav_order: 5 +has_children: true --- # Developer guide diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 777177cc0a..3b00cecf20 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -1,7 +1,8 @@ --- title: "Get started" layout: default -sort: 1 +nav_order: 1 +has_children: true --- # Node Feature Discovery diff --git a/docs/get-started/introduction.md b/docs/get-started/introduction.md index 73b7b8e451..9ba3789815 100644 --- a/docs/get-started/introduction.md +++ b/docs/get-started/introduction.md @@ -1,7 +1,8 @@ --- title: "Introduction" +parent: "Get started" layout: default -sort: 1 +nav_order: 1 --- # Introduction diff --git a/docs/get-started/quick-start.md b/docs/get-started/quick-start.md index 02c96fc10b..8ddf46c0b7 100644 --- a/docs/get-started/quick-start.md +++ b/docs/get-started/quick-start.md @@ -1,7 +1,8 @@ --- title: "Quick start" +parent: "Get started" layout: default -sort: 2 +nav_order: 2 --- # Quick start diff --git a/docs/reference/architecture.md b/docs/reference/architecture.md index 194b13c209..725a7fc629 100644 --- a/docs/reference/architecture.md +++ b/docs/reference/architecture.md @@ -1,7 +1,8 @@ --- title: "Architecture" +parent: "Reference" layout: default -sort: 6 +nav_order: 6 published: false --- diff --git a/docs/reference/e2e-configuration-reference.md b/docs/reference/e2e-configuration-reference.md index 688bf23c8e..1628a0fd3e 100644 --- a/docs/reference/e2e-configuration-reference.md +++ b/docs/reference/e2e-configuration-reference.md @@ -1,7 +1,8 @@ --- title: "E2E-test config reference" +parent: "Reference" layout: default -sort: 5 +nav_order: 5 published: false --- diff --git a/docs/reference/feature-gates.md b/docs/reference/feature-gates.md index f75d8a7ae3..a95c34f7f7 100644 --- a/docs/reference/feature-gates.md +++ b/docs/reference/feature-gates.md @@ -1,7 +1,8 @@ --- title: "Feature Gates" +parent: "Reference" layout: default -sort: 11 +nav_order: 11 --- # Feature Gates diff --git a/docs/reference/gc-commandline-reference.md b/docs/reference/gc-commandline-reference.md index 101adaf280..3bc2533d86 100644 --- a/docs/reference/gc-commandline-reference.md +++ b/docs/reference/gc-commandline-reference.md @@ -1,7 +1,8 @@ --- title: "Garbage Collector Cmdline Reference" +parent: "Reference" layout: default -sort: 7 +nav_order: 7 --- # NFD-GC Commandline Flags diff --git a/docs/reference/index.md b/docs/reference/index.md index 80c15fe321..6736034a48 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,7 +1,8 @@ --- title: "Reference" layout: default -sort: 4 +nav_order: 4 +has_children: true --- # Reference diff --git a/docs/reference/master-commandline-reference.md b/docs/reference/master-commandline-reference.md index e17567ff5b..b1fa260bd8 100644 --- a/docs/reference/master-commandline-reference.md +++ b/docs/reference/master-commandline-reference.md @@ -1,7 +1,8 @@ --- title: "Master cmdline reference" +parent: "Reference" layout: default -sort: 1 +nav_order: 1 --- # Commandline flags of nfd-master diff --git a/docs/reference/master-configuration-reference.md b/docs/reference/master-configuration-reference.md index 6d4204c51d..28a649ac1c 100644 --- a/docs/reference/master-configuration-reference.md +++ b/docs/reference/master-configuration-reference.md @@ -1,7 +1,8 @@ --- title: "Master config reference" +parent: "Reference" layout: default -sort: 3 +nav_order: 3 --- # Configuration file reference of nfd-master diff --git a/docs/reference/node-feature-client-reference.md b/docs/reference/node-feature-client-reference.md index 9a723a7836..418ea7d568 100644 --- a/docs/reference/node-feature-client-reference.md +++ b/docs/reference/node-feature-client-reference.md @@ -1,7 +1,8 @@ --- title: "Node Feature client cmdline reference" +parent: "Reference" layout: default -sort: 9 +nav_order: 9 --- # Commandline flags of nfd client diff --git a/docs/reference/plugin-commandline-reference.md b/docs/reference/plugin-commandline-reference.md index 8c7752e00d..8607eb200e 100644 --- a/docs/reference/plugin-commandline-reference.md +++ b/docs/reference/plugin-commandline-reference.md @@ -1,7 +1,8 @@ --- title: "Kubectl plugin cmdline reference" +parent: "Reference" layout: default -sort: 8 +nav_order: 8 --- # Commandline flags of kubectl-nfd (plugin) diff --git a/docs/reference/topology-updater-commandline-reference.md b/docs/reference/topology-updater-commandline-reference.md index cd27b4ede7..7f2b5b5e24 100644 --- a/docs/reference/topology-updater-commandline-reference.md +++ b/docs/reference/topology-updater-commandline-reference.md @@ -1,7 +1,8 @@ --- title: "Topology Updater Cmdline Reference" +parent: "Reference" layout: default -sort: 5 +nav_order: 5 --- # NFD-Topology-Updater Commandline Flags diff --git a/docs/reference/topology-updater-configuration-reference.md b/docs/reference/topology-updater-configuration-reference.md index 6660a1587b..4c70c9038b 100644 --- a/docs/reference/topology-updater-configuration-reference.md +++ b/docs/reference/topology-updater-configuration-reference.md @@ -1,7 +1,8 @@ --- title: "Topology-Updater config reference" +parent: "Reference" layout: default -sort: 6 +nav_order: 6 --- # Configuration file reference of nfd-topology-updater diff --git a/docs/reference/versions.md b/docs/reference/versions.md index b192250d66..5168743903 100644 --- a/docs/reference/versions.md +++ b/docs/reference/versions.md @@ -1,7 +1,8 @@ --- title: "Versions" +parent: "Reference" layout: default -sort: 10 +nav_order: 10 --- # Versions and deprecation diff --git a/docs/reference/worker-commandline-reference.md b/docs/reference/worker-commandline-reference.md index 842c859903..0f6e27c677 100644 --- a/docs/reference/worker-commandline-reference.md +++ b/docs/reference/worker-commandline-reference.md @@ -1,7 +1,8 @@ --- title: "Worker cmdline reference" +parent: "Reference" layout: default -sort: 2 +nav_order: 2 --- # Commandline flags of nfd-worker diff --git a/docs/reference/worker-configuration-reference.md b/docs/reference/worker-configuration-reference.md index e51353ee00..a7eea01572 100644 --- a/docs/reference/worker-configuration-reference.md +++ b/docs/reference/worker-configuration-reference.md @@ -1,7 +1,8 @@ --- title: "Worker config reference" +parent: "Reference" layout: default -sort: 4 +nav_order: 4 --- # Configuration file reference of nfd-worker diff --git a/docs/usage/custom-resources.md b/docs/usage/custom-resources.md index 5508d79798..3cf9a0d108 100644 --- a/docs/usage/custom-resources.md +++ b/docs/usage/custom-resources.md @@ -1,7 +1,8 @@ --- title: "CRDs" +parent: "Usage" layout: default -sort: 7 +nav_order: 7 --- # Custom Resources diff --git a/docs/usage/customization-guide.md b/docs/usage/customization-guide.md index 4fd91784bb..97bb0f7ff8 100644 --- a/docs/usage/customization-guide.md +++ b/docs/usage/customization-guide.md @@ -1,7 +1,8 @@ --- title: "Customization guide" +parent: "Usage" layout: default -sort: 8 +nav_order: 8 --- # Customization guide diff --git a/docs/usage/examples-and-demos.md b/docs/usage/examples-and-demos.md index 36936bf64f..8b02057a17 100644 --- a/docs/usage/examples-and-demos.md +++ b/docs/usage/examples-and-demos.md @@ -1,7 +1,8 @@ --- title: "Examples and demos" +parent: "Usage" layout: default -sort: 9 +nav_order: 9 --- # Examples and demos diff --git a/docs/usage/features.md b/docs/usage/features.md index e1e73aada9..5aa0ce2663 100644 --- a/docs/usage/features.md +++ b/docs/usage/features.md @@ -1,7 +1,8 @@ --- title: "Feature labels" +parent: "Usage" layout: default -sort: 1 +nav_order: 1 --- # Feature labels diff --git a/docs/usage/image-compatibility.md b/docs/usage/image-compatibility.md index 25845bb0fa..31c7147c26 100644 --- a/docs/usage/image-compatibility.md +++ b/docs/usage/image-compatibility.md @@ -1,7 +1,8 @@ --- title: "Image Compatibility Artifact" +parent: "Usage" layout: default -sort: 11 +nav_order: 11 --- # Image Compatibility Artifact diff --git a/docs/usage/index.md b/docs/usage/index.md index 409b00d34e..3b0c11228f 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -1,7 +1,8 @@ --- title: "Usage" layout: default -sort: 3 +nav_order: 3 +has_children: true --- # Usage diff --git a/docs/usage/kubectl-plugin.md b/docs/usage/kubectl-plugin.md index 040be4bf1d..135c85c048 100644 --- a/docs/usage/kubectl-plugin.md +++ b/docs/usage/kubectl-plugin.md @@ -1,7 +1,8 @@ --- title: "Kubectl plugin" +parent: "Usage" layout: default -sort: 10 +nav_order: 10 --- # Kubectl plugin diff --git a/docs/usage/nfd-gc.md b/docs/usage/nfd-gc.md index 5481598e2a..36a2c0f9b7 100644 --- a/docs/usage/nfd-gc.md +++ b/docs/usage/nfd-gc.md @@ -1,7 +1,8 @@ --- title: "NFD-Garbage-Collector" +parent: "Usage" layout: default -sort: 6 +nav_order: 6 --- # NFD-GC diff --git a/docs/usage/nfd-master.md b/docs/usage/nfd-master.md index eb2823cabe..750f0b5173 100644 --- a/docs/usage/nfd-master.md +++ b/docs/usage/nfd-master.md @@ -1,7 +1,8 @@ --- title: "NFD-Master" +parent: "Usage" layout: default -sort: 3 +nav_order: 3 --- # NFD-Master diff --git a/docs/usage/nfd-topology-updater.md b/docs/usage/nfd-topology-updater.md index 4674ea61ff..e327149b00 100644 --- a/docs/usage/nfd-topology-updater.md +++ b/docs/usage/nfd-topology-updater.md @@ -1,7 +1,8 @@ --- title: "NFD-Topology-Updater" +parent: "Usage" layout: default -sort: 5 +nav_order: 5 --- # NFD-Topology-Updater diff --git a/docs/usage/nfd-worker.md b/docs/usage/nfd-worker.md index 7e9b9b0f3b..98bcd6f6df 100644 --- a/docs/usage/nfd-worker.md +++ b/docs/usage/nfd-worker.md @@ -1,7 +1,8 @@ --- title: "NFD-Worker" +parent: "Usage" layout: default -sort: 4 +nav_order: 4 --- # NFD-Worker diff --git a/docs/usage/using-labels.md b/docs/usage/using-labels.md index d7a88faab0..2fa9b2335a 100644 --- a/docs/usage/using-labels.md +++ b/docs/usage/using-labels.md @@ -1,7 +1,8 @@ --- title: "Using node labels" +parent: "Usage" layout: default -sort: 2 +nav_order: 2 --- # Using node labels