DOCS-3012: Remove duplicate headings from the web console access page - #2933
Merged
Conversation
The web console access page put an H3 heading inside each of the four tabs in the How to section. Docusaurus builds the table of contents from the headings in the source, not from the tab the reader has selected, so all four copies of "Log in to the Calico Enterprise web console" appeared at once, with duplicate anchor slugs. Change the four in-tab headings to bold text, matching the bold labels the same tabs already use. Replace the "Configure access to the Calico Enterprise web console" heading, which restated the page title, with a line that tells the reader to select a tab. Applies to Calico Enterprise 3.21, 3.22, 3.23, 3.24, and next.
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Removes duplicate “Log in to the Calico Enterprise web console” entries from the generated Docusaurus table of contents on the “Configure access to the web console” page by eliminating repeated in-tab headings that were being indexed multiple times across Tabs.
Changes:
- Replaced the in-tab
### Log in to the $[prodname] web consoleheadings with bold text to prevent duplicate ToC entries. - Replaced the redundant
### Configure access to the $[prodname] web consolesubheading with an instructional sentence that doesn’t introduce a ToC entry. - Applied the same ToC-fix pattern consistently across Calico Enterprise “next” and versions 3.21–3.24.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| calico-enterprise/operations/cnx/access-the-manager.mdx | Removes duplicate ToC entries by converting repeated tab headings to bold text and replacing a redundant H3 with instructional text. |
| calico-enterprise_versioned_docs/version-3.24-1/operations/cnx/access-the-manager.mdx | Same ToC de-duplication adjustments for Enterprise 3.24. |
| calico-enterprise_versioned_docs/version-3.23-2/operations/cnx/access-the-manager.mdx | Same ToC de-duplication adjustments for Enterprise 3.23. |
| calico-enterprise_versioned_docs/version-3.22-2/operations/cnx/access-the-manager.mdx | Same ToC de-duplication adjustments for Enterprise 3.22. |
| calico-enterprise_versioned_docs/version-3.21-2/operations/cnx/access-the-manager.mdx | Same ToC de-duplication adjustments for Enterprise 3.21. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The "Configure access to the web console" page listed "Log in to the Calico Enterprise web console" four times in the table of contents. The page has four tabs in the How to section, and each tab ended with its own H3 heading. Docusaurus builds the table of contents from the headings in the source, not from the tab the reader has selected, so all four headings appeared at once and generated duplicate anchor slugs.
Changes:
The table of contents now reads: Big picture, Value, Before you begin, How to, Additional resources.
Applied to Calico Enterprise 3.21, 3.22, 3.23, 3.24, and next. Calico Enterprise 3.20 has the same problem but is not in onlyIncludeVersions, so it is not built. Calico Cloud and Calico Open Source have no equivalent page.
No page links to the removed anchors. The similar link in quickstart.mdx points to a heading on that page.
Ticket: https://tigera.atlassian.net/browse/DOCS-3012
Follow-up: 57 files across the repo put headings inside Tabs, and 11 distinct pages repeat a heading text that way, including the Windows demo, the IP pool migration pages, and the Kubernetes audit log pages. Those need a separate ticket.
When the deploy preview builds, check the table of contents on: