kubernetes-sigs · marquiz · Jun 11, 2025
diff --git 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
@@ -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
@@ -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
@@ -0,0 +1,30 @@
+{% if site.display_version_list %}
+    <div class="version-menu">
+      <label for="versions">Version:</label>
+        <select id="versions" onchange="location = this.value;">
+        {% if jekyll.environment == "development" %}
+          <option value="{{ site.baseurl }}/">{{ site.version }}</option>
+        {% 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: "/" %}
+
+            <script src="{{ baseurl }}/versions.js"></script>
+            <script>
+                var select = document.getElementById('versions');
+                var items = getVersionListItems();
+                for (var i=0; i < items.length; i++) {
+                  var opt = document.createElement('option');
+                  opt.appendChild(document.createTextNode(items[i].name));
+                  opt.value = items[i].url;
+                  select.appendChild(opt);
+                }
+            </script>
+        {% endif %}
+        </select>
+    </div>
+{% endif %}
diff --git a/docs/_includes/templates/addons.liquid b/docs/_includes/templates/addons.liquid
diff --git a/docs/_includes/templates/sidebar.liquid b/docs/_includes/templates/sidebar.liquid
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,7 +1,8 @@
 ---
 title: "Master config reference"
+parent: "Reference"
 layout: default
-sort: 3
+nav_order: 3
 ---
 
 # Configuration file reference of nfd-master