DOCS-1850 Make hideTOC conditional and change it to a YAML key

Qumulo · Nov 3, 2023 · 57c32fd · 57c32fd
1 parent 5d40c0d
commit 57c32fd
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -3,10 +3,9 @@ title: "Qumulo Documentation"
 summary: "Welcome to the Qumulo Documentation Portal. This repository uses <a href='https://www.writethedocs.org/guide/docs-as-code/'>docs-as-code principles</a> to provide guidance about working with Qumulo."
 permalink: index.html
 breadcrumbs: exclude
+hideTOC: true
 ---
 
-{{site.hideTOC}}
-
 To get started, choose one of the following guides.
 
 

diff --git a/_config.yml b/_config.yml
@@ -135,7 +135,6 @@ plugins:
   - jekyll-redirect-from
 
 # Global include variables
-hideTOC: <style>div#toc{display:none;}</style>
 loginRequired: <span class="emoji">🔒</span>
 
 nexusDownloads: For downloads, release notes, and upgrade paths for on-premises and cloud releases of Qumulo Core, see <a target="_blank" href="https://nexus.qumulo.com/downloads">Qumulo Nexus</a>

diff --git a/_layouts/page.html b/_layouts/page.html
@@ -42,5 +42,15 @@ <h1 class="post-title-main">{{ page.title }}</h1>
 
 {% include in_page_toc.html %}
 
+{% if page.hideTOC %}
+<script>
+    document.addEventListener('DOMContentLoaded', function() {
+        var styleElement = document.createElement('style');
+        styleElement.innerHTML = 'div#toc { display: none; }';
+        document.head.appendChild(styleElement);
+    });
+</script>
+{% endif %}
+
 </div>
 
diff --git a/administrator-guide/upgrading-qumulo-core/mode-reference.md b/administrator-guide/upgrading-qumulo-core/mode-reference.md
@@ -6,10 +6,9 @@ redirect_from:
   - /administrator-guide/upgrades/mode-reference.html
 sidebar: administrator_guide_sidebar
 keywords: update, upgrade, instant, instant_software_upgrade, platform, platform_upgrade
+hideTOC: true
 ---
 
-{{site.hideTOC}}
-
 * An [_instant software upgrade_](instant-software-platform.html#instant-software-upgrade) requires restarting only the container on your nodes and has a downtime of less than 30 seconds without disruption to the operation of the cluster.
 * A [_platform upgrade_](instant-software-platform.html#platform-upgrade) requires either a complete reboot (rebooting all nodes in your cluster at the same time) or a rolling reboot (rebooting the nodes in your cluster one at a time).
 * A <em>quarterly upgrade</em> aggregates all improvements and fixes since the last quarterly upgrade. The version number of a quarterly upgrade ends in `.0`.