Skip to content

Commit

Permalink
docs: set toc_max_heading_level to default value 3 for all docs DOC-9…
Browse files Browse the repository at this point in the history
…38 (#1947)

This patch makes the following changes:
- sets the `toc_max_heading_level` to default value 3
- removes redundant frontmatter settings for this level
  • Loading branch information
addetz committed Dec 28, 2023
1 parent 36c4d08 commit 56bd6e3
Show file tree
Hide file tree
Showing 8 changed files with 3 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ sidebar_custom_props:
| `sidebar_custom_props:`<br>` 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---

Expand Down
2 changes: 0 additions & 2 deletions docs/docs-content/clusters/data-center/openstack.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---

Expand Down
2 changes: 0 additions & 2 deletions docs/docs-content/clusters/data-center/vmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
---

Expand Down
2 changes: 0 additions & 2 deletions docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
---


Expand Down
2 changes: 0 additions & 2 deletions docs/docs-content/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 56bd6e3

Please sign in to comment.