From 56bd6e38140e5617d5ef41486caf1cc2b9cefb95 Mon Sep 17 00:00:00 2001 From: Adelina Simion <43963729+addetz@users.noreply.github.com> Date: Thu, 28 Dec 2023 16:31:34 +0000 Subject: [PATCH] docs: set toc_max_heading_level to default value 3 for all docs DOC-938 (#1947) This patch makes the following changes: - sets the `toc_max_heading_level` to default value 3 - removes redundant frontmatter settings for this level --- README.md | 4 ++-- .../clusters/data-center/maas/install-manage-maas-pcg.md | 2 -- docs/docs-content/clusters/data-center/openstack.md | 2 -- docs/docs-content/clusters/data-center/vmware.md | 2 -- docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md | 2 -- .../registries-and-packs/spectro-cli-reference.md | 1 - docs/docs-content/release-notes.md | 2 -- docusaurus.config.js | 2 +- 8 files changed, 3 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8c3ba87b51..78250ea11b 100644 --- a/README.md +++ b/README.md @@ -153,8 +153,8 @@ sidebar_custom_props: | `sidebar_custom_props:`
` icon: "graph"` | string | one of icons from https://fontawesome.com/icons?d=gallery | | `hide_table_of_contents` | boolean | setting this to `false` will hide the page from the navigation | | `sidebar_position` | number | the position of the page in the navigation sidebar. The pages are sorted ascending by this value | -| `toc_min_heading_level` | number | the minimum heading level to show in the table of contents. | -| `toc_max_heading_level` | number | the maximum heading level to show in the table of contents. | +| `toc_min_heading_level` | number | the minimum heading level to show in the table of contents. The default value for all documents is `2`. | +| `toc_max_heading_level` | number | the maximum heading level to show in the table of contents. The default value for all documents is `3`. | | `tags` | array | A list of string that can be used for additonal categorization of content. | | `keywords` | array | A list of strings that areused for SEO purposes. | ### Sub pages diff --git a/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md b/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md index 4ea8db1efd..b71475febd 100644 --- a/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md +++ b/docs/docs-content/clusters/data-center/maas/install-manage-maas-pcg.md @@ -4,8 +4,6 @@ title: "Install and Manage MAAS Private Cloud Gateway" description: "Learn how to install and manage the MAAS Private Cloud Gateway in Palette." hide_table_of_contents: false sidebar_position: 10 -toc_min_heading_level: 2 -toc_max_heading_level: 3 tags: ["data center", "maas"] --- diff --git a/docs/docs-content/clusters/data-center/openstack.md b/docs/docs-content/clusters/data-center/openstack.md index 371375f9d9..e030db21a0 100644 --- a/docs/docs-content/clusters/data-center/openstack.md +++ b/docs/docs-content/clusters/data-center/openstack.md @@ -4,8 +4,6 @@ title: "OpenStack" description: "The methods of creating clusters for a speedy deployment on any CSP" hide_table_of_contents: false sidebar_position: 20 -toc_min_heading_level: 2 -toc_max_heading_level: 3 tags: ["data center", "openstack"] --- diff --git a/docs/docs-content/clusters/data-center/vmware.md b/docs/docs-content/clusters/data-center/vmware.md index fd33786330..d451647e5e 100644 --- a/docs/docs-content/clusters/data-center/vmware.md +++ b/docs/docs-content/clusters/data-center/vmware.md @@ -4,8 +4,6 @@ title: "VMware" description: "Learn how to configure VMware to create VMware clusters in Palette." hide_table_of_contents: false sidebar_position: 30 -toc_min_heading_level: 2 -toc_max_heading_level: 3 tags: ["data center", "vmware"] --- diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index 4fa8cae9d1..90126f4c50 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -6,8 +6,6 @@ icon: "" category: ["tutorial"] hide_table_of_contents: false tags: ["public cloud", "aws", "azure", "gcp", "tutorial"] -toc_min_heading_level: 2 -toc_max_heading_level: 3 sidebar_position: 50 --- diff --git a/docs/docs-content/registries-and-packs/spectro-cli-reference.md b/docs/docs-content/registries-and-packs/spectro-cli-reference.md index 6e02d1ad25..5043f3bb36 100644 --- a/docs/docs-content/registries-and-packs/spectro-cli-reference.md +++ b/docs/docs-content/registries-and-packs/spectro-cli-reference.md @@ -5,7 +5,6 @@ description: "A reference sheet for the Spectro Cloud CLI tool" icon: "" hide_table_of_contents: false sidebar_position: 10 -toc_max_heading_level: 3 --- diff --git a/docs/docs-content/release-notes.md b/docs/docs-content/release-notes.md index 745b7ade7b..c48d3f77b9 100644 --- a/docs/docs-content/release-notes.md +++ b/docs/docs-content/release-notes.md @@ -3,8 +3,6 @@ sidebar_label: "Release Notes" title: "Release Notes" description: "Spectro Cloud release notes for Palette and its sub-components." hide_table_of_contents: false -toc_min_heading_level: 2 -toc_max_heading_level: 3 sidebar_position: 0 sidebar_custom_props: icon: "audits" diff --git a/docusaurus.config.js b/docusaurus.config.js index 853c795e90..f4cbefc234 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -248,7 +248,7 @@ const config = { }, tableOfContents: { minHeadingLevel: 2, - maxHeadingLevel: 6, + maxHeadingLevel: 3, }, // Replace with your project's social card image: "img/spectro-cloud-social-card.png",