Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: set toc_max_heading_level to default value 3 for all docs DOC-938 #1947

Merged
merged 1 commit into from
Dec 28, 2023
Merged

docs: set toc_max_heading_level to default value 3 for all docs DOC-938 #1947

merged 1 commit into from
Dec 28, 2023

Conversation

addetz
Copy link
Contributor

@addetz addetz commented Dec 28, 2023

Describe the Change

This patch makes the following changes:

  • sets the toc_max_heading_level to default value 3
  • removes redundant frontmatter settings for this level

Review Changes

💻 Add Preview URL

🎫 Jira Ticket

@addetz
docs: set toc_max_heading_level to default value 3 for all docs DOC-938
97b0d2a 
This patch makes the following changes:
- sets the `toc_max_heading_level` to default value 3
- removes redundant frontmatter settings for this level
@addetz addetz requested a review from a team as a code owner December 28, 2023 14:54
@netlify Netlify
Copy link

netlify bot commented Dec 28, 2023 •
edited
Loading

✅ Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 97b0d2a
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/658d8c1033f6b9000875395c
😎 Deploy Preview https://deploy-preview-1947--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@karl-cardenas-coding
Copy link
Contributor

@addetz will this also apply to the API plugin ID? We use two plugins to display our docs, the main or default one, and another one for API docs.

@addetz
Copy link
Contributor Author

addetz commented Dec 28, 2023 •
edited
Loading

@addetz will this also apply to the API plugin ID? We use two plugins to display our docs, the main or default one, and another one for API docs.

Hi @karl-cardenas-coding! Yes, the themeConfig applies to both plugins. Now that you mention it, I'm not sure this is the desired behaviour 🤔

@karl-cardenas-coding
Copy link
Contributor

@addetz I think for now we're good but yeah I agree that ideally, the two are decoupled for more flexibility.

@karl-cardenas-coding karl-cardenas-coding added enhancement New feature or request backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 labels Dec 28, 2023
@addetz addetz merged commit b31b006 into master Dec 28, 2023
13 checks passed
@addetz addetz deleted the max-toc-heading-doc-938 branch December 28, 2023 16:31
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 28, 2023
@addetz
docs: set toc_max_heading_level to default value 3 for all docs DOC-9…
e73dda1 
…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

(cherry picked from commit b31b006)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 28, 2023
Merged
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Dec 28, 2023
@addetz
docs: set toc_max_heading_level to default value 3 for all docs DOC-9…
f30efc6 
…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

(cherry picked from commit b31b006)
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Dec 28, 2023
Merged
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
✅ version-4-0
❌ version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- docs: Provide missing Autocale information (#1857) DOC-897
- ci: Image prune correction (#1923)
✅ version-4-1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 1947

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

addetz added a commit that referenced this pull request Dec 28, 2023
@vault-token-factory-spectrocloud @addetz
docs: set toc_max_heading_level to default value 3 for all docs DOC-9…
d075acb 
…38 (#1947) (#1949)

This patch makes the following changes:
- sets the `toc_max_heading_level` to default value 3
- removes redundant frontmatter settings for this level

(cherry picked from commit b31b006)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
addetz added a commit that referenced this pull request Dec 28, 2023
@vault-token-factory-spectrocloud @addetz
docs: set toc_max_heading_level to default value 3 for all docs DOC-9…
a99957b 
…38 (#1947) (#1948)

This patch makes the following changes:
- sets the `toc_max_heading_level` to default value 3
- removes redundant frontmatter settings for this level

(cherry picked from commit b31b006)

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
addetz added a commit that referenced this pull request Dec 28, 2023
@addetz
docs: set toc_max_heading_level to default value 3 for all docs DOC-9…
56bd6e3 
…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
@addetz
Copy link
Contributor Author

addetz commented Dec 28, 2023

Merged into version-3-4 through cherry-pick
56bd6e3

@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Jan 8, 2024
Merged
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Jan 17, 2024
Merged
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Feb 13, 2024
Merged
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Mar 22, 2024
Merged
2 tasks
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Mar 28, 2024
Merged
2 tasks
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Apr 9, 2024
Merged
2 tasks
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request May 7, 2024
Merged
2 tasks
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Jul 16, 2024
Merged
2 tasks
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Aug 30, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@karl-cardenas-coding karl-cardenas-coding karl-cardenas-coding approved these changes

@lennessyy lennessyy Awaiting requested review from lennessyy lennessyy is a code owner automatically assigned from spectrocloud/docs-education

@ritawatson ritawatson Awaiting requested review from ritawatson ritawatson is a code owner automatically assigned from spectrocloud/docs-education

Assignees
No one assigned
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@addetz @karl-cardenas-coding