docs: Convert Prerequisites sections to admonitions in enterprise docs#1154
Open
justinegeffen wants to merge 7 commits intomasterfrom
Open
docs: Convert Prerequisites sections to admonitions in enterprise docs#1154justinegeffen wants to merge 7 commits intomasterfrom
justinegeffen wants to merge 7 commits intomasterfrom
Conversation
Convert all Prerequisites sections from headings to info admonitions across Platform Enterprise documentation and version 25.3. This provides better visual consistency and improves the user experience by making prerequisite information more prominent and accessible. Changes: - Convert 40 files from ## Prerequisites headings to :::info admonitions - Add HTML anchors (<a id="prerequisites"></a>) to preserve backward compatibility for internal links - Apply changes to both current and versioned (25.3) documentation Files updated: - Installation docs (Platform, Studios, Groundswell) - Authentication provider docs (Email, Entra, GitHub, Google, Keycloak, Okta) - Manual Azure Batch setup documentation Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
justinegeffen
added
1. Editor review
Replace HTML anchors with Markdown heading anchors to resolve Docusaurus
broken anchor warnings. This change allows builds to pass with
FAIL_ON_BROKEN_LINKS=true enabled in CI/CD pipelines.
Change format from:
<a id="prerequisites"></a>
:::info[**Prerequisites**]
To:
:::info
## Prerequisites {#prerequisites}
This approach:
- Eliminates broken anchor warnings in Docusaurus builds
- Preserves backward compatibility for #prerequisites links
- Uses native Docusaurus anchor detection
- Allows successful deployment with strict link checking
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Replace heading-based anchors with span elements containing IDs inside the admonition title. This maintains the clean "Prerequisites" title styling while preserving anchor functionality for internal links. Format: :::info <span id="prerequisites">**Prerequisites**</span> This approach provides: - Clean admonition title (shows "Prerequisites" not "info") - Working anchor navigation (#prerequisites) - Build succeeds (warnings only, not errors) - Compatible with existing internal links Note: Docusaurus static analyzer shows warnings for span IDs, but these are non-blocking and the anchors work correctly in browsers. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Member
|
Sorry, I think I made a bad suggestion earlier without checking the product. I just had a proper tinker with this and think that a better solution would be to use: Then, add the following to the The CSS helps offset anchor targets to account for the fixed header. The fixed fits the page at 100x, but is offset on the mobile site. I think this will resolve the missing anchors while keeping the "Prerequisites" title clean in the admonition. I would propose this fix and custom css for now, think about a better way to anchor the headings on the mobile nav (regular headings have the same issue) and once resolved, graduate the fix to the Seqera theme. |
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
3 participants
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.
Summary
Converts all Prerequisites sections from headings to info admonitions across Platform Enterprise documentation (current and version 25.3). This change improves visual consistency and makes prerequisite information more prominent for users.
Changes
## Prerequisitesheadings to:::info[**Prerequisites**]admonitions<a id="prerequisites"></a>) to preserve backward compatibility for internal linksFiles Updated
Installation Documentation
Authentication Provider Documentation
Advanced Topics
Before & After
Before:
## Prerequisites You need to have...After:
Testing
npm run build- no errorsnpm start#prerequisites)Notes
#prerequisites🤖 Generated with Claude Code