Merge pull request #2222 from marquiz/release-0.7

[release-0.7] docs: switch to jekyll-theme-read-the-docs

Author: k8s-ci-robot

.github/workflows/gh-pages.yml

@@ -5,11 +5,20 @@ on:
       - master
       - release-*
     tags:
-      - v*
+      - v[0-9]+.[0-9]+.[0-9]+
+
+concurrency:
+  group: gh-pages
+
+permissions:
+  contents: read
+
 jobs:
   build:
     name: Update gh-pages
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
 
     - name: Check out repo

docs/_config.yml

@@ -26,7 +26,7 @@ markdown: kramdown
 kramdown:
   toc_levels: 1..3
 
-remote_theme: rundocs/jekyll-rtd-theme@v2.0.9
+remote_theme: jv-conseil/jekyll-theme-read-the-docs@ce7ed5ad2184b36244a50adbeea2f0a6ab1f8606
 
 # Exclude from processing.
 # The following items will not be processed, by default. Create a custom list

docs/_includes/class/addons-wrap.liquid renamed to docs/_includes/templates/addons.liquid

@@ -43,14 +43,31 @@
                 {% endif %}
             </dl>
         {% endif %}
-        {%- assign items = "github" | split: ", " -%}
-        {% for item in items -%}
-            {% include addons/{{ item }}.liquid %}
-        {% endfor -%}
+        <dl>
+            <dt>{{ __.github | default: "GitHub" }}</dt>
+            <dd>
+                <a href="{{ docs.repository_url }}" title="{{ __.stars | default: 'Stars' }}: {{ rest.stargazers_count }}">
+                    <i class="fa fa-github"></i>
+                    {{ __.homepage | default: "Homepage" }}
+                </a>
+            </dd>
+            <dd>
+                <a href="{{ docs.issues_url }}" title="{{ __.open_issues | default: 'Open issues' }}: {{ rest.open_issues }}">
+                    <i class="fa fa-question-circle-o"></i>
+                    {{ __.issues | default: "Issues" }}
+                </a>
+            </dd>
+            <dd>
+                <a href="{{ docs.zip_url }}" title="{{ __.size | default: 'Size' }}: {{ rest.size }} Kb">
+                    <i class="fa fa-download"></i>
+                    {{ __.download | default: "Download" }}
+                </a>
+            </dd>
+        </dl>
         <hr>
         <div class="license f6 pb-2">
-            The
-            <a href="{{ site.baseurl }}/">software</a>
+            This
+            <a href="{{ site.baseurl }}/" title="{{ site.title }}">Software</a>
             is under the terms of
             <a href="{{ docs.repository_url }}">{{ docs.license.name | default: "The Unlicense" }}</a>.
         </div>

docs/_includes/templates/content.liquid

@@ -0,0 +1,26 @@
+<div class="content-wrap">
+    <div class="header d-flex flex-justify-between p-2 hide-lg hide-xl" aria-label="top navigation">
+        <button id="toggle" aria-label="Toggle menu" class="btn-octicon p-2 m-0 text-white" type="button">
+            <i class="fa fa-bars"></i>
+        </button>
+        <div class="title flex-1 d-flex flex-justify-center">
+            <a class="h4 no-underline py-1 px-2 rounded-1" href="{{ site.baseurl }}/">{{ site.title }}</a>
+        </div>
+    </div>
+    <div class="bg-red-2">
+        <div class="content p-3 px-sm-5">
+            This documentation is for Node Feature Discovery version that is no longer supported. Please upgrade and visit the
+            <a class="no-underline" href="{{ '../stable' | relative_url }}">documentation of the latest stable release</a>.
+        </div>
+    </div>
+    <div class="content p-3 p-sm-5">
+        {% include templates/breadcrumbs.liquid %}
+        <hr>
+        <div role="main" itemscope="itemscope" itemtype="https://schema.org/Article">
+            <div class="markdown-body" itemprop="articleBody">
+                {{ content }}
+            </div>
+        </div>
+        {% include templates/footer.liquid %}
+    </div>
+</div>

docs/_includes/class/sidebar-wrap.liquid renamed to docs/_includes/templates/sidebar.liquid

@@ -12,7 +12,7 @@
             </form>
         </div>
         <div class="toctree py-2" data-spy="affix" role="navigation" aria-label="main navigation">
-            {% include class/_toctree.liquid %}
+            {% include templates/toctree.liquid %}
         </div>
     </div>
 </div>