chore: promote Secure to top-level Antora module (JTBD Phase 2) (#3134)#3156
Merged
Conversation
* chore: promote Secure to top-level Antora module (JTBD Phase 2)
Move security content from Administration Guide into a new
modules/secure/ Antora module, following the CCS 'Secure' category:
'Implement security controls and ensure compliance.'
- Create modules/secure/ with nav and 12 pages
- Move security-best-practices, OAuth provider pages (6), identity
management, authorization, GDPR compliance from admin-guide
- Add page-aliases for backward-compatible redirects
- Apply JTBD titles from downstream audit:
"Protect your deployment", "Give developers credential-free Git
access", "Control who can access {prod-short}", etc.
- Update cross-module xrefs in install, end-user-guide, discover
- Remove security sections from admin-guide nav
- Add modules/secure/nav.adoc to antora.yml
Mirrors downstream devspaces-documentation Secure guide structure.
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: move OAuth for Git providers back to Administration Guide
SME feedback: OAuth configuration is a day-1 admin setup task,
not a security hardening concern. Keep it in the Administration
Guide where admins expect to find it.
Moved 7 OAuth pages from modules/secure/pages/ back to
modules/administration-guide/pages/. Updated nav.adoc for both
modules and 3 cross-module xrefs (secure: -> administration-guide:).
Secure module retains: security best practices, identity management,
cluster roles, advanced authorization, GDPR compliance.
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: replace pass:[] Vale pragmas with passthrough blocks to fix RedHat.Spacing errors
* fix: remove self-referencing page-aliases from OAuth files
* fix: remove self-referencing page-aliases from GitLab OAuth file
* fix: remove self-referencing page-aliases from Azure DevOps OAuth file
* fix: add cross-module prefixes for includes and xrefs in secure module pages
* fix: add cross-module xref prefix in configuring-advanced-authorization
* fix: add cross-module xref prefixes in GDPR compliance page
* fix: add cross-module prefixes for includes and xrefs in security-best-practices
* feat: add persona callouts to Secure module using partials
- Per-page admin persona callout via discover:partial$snip_persona-admin.adoc
in all 5 secure pages
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: use local secure partial instead of cross-module discover:partial
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: remove persona partial from thin wrapper page (level-0 heading conflict)
configuring-cluster-roles-for-users.adoc is a thin wrapper that includes
the full page content from administration-guide example snippet. Adding
a persona partial before that creates two level-0 headings, which breaks
Antora. The guide-level callout in the nav/master provides the persona
signal for this page.
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: revert OAuth title to factual 'Configuring OAuth for Git providers'
SME feedback: JTBD title 'Give developers credential-free Git access'
is inaccurate (OAuth still uses credentials) and not findable for
admins searching for 'OAuth' or 'GitHub configuration'.
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: apply JTBD navtitle for cluster roles page
Change navtitle from "Configuring cluster roles for users" to
"Grant additional permissions to users" to match downstream JTBD title.
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: sync navtitle attributes with JTBD page titles in Secure
Co-authored-by: Cursor <cursoragent@cursor.com>
---------
Co-authored-by: Cursor <cursoragent@cursor.com>
mkuznyetsov
requested review from
a team,
deerskindoll and
gtrivedi88
as code owners
|
🎊 Navigate the preview: https://6a4b88a226cb01008f79b7b1--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
gtrivedi88
approved these changes
Jul 6, 2026
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
2 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.
What does this pull request change?
Cherry-pick content from #3134 , as it contains fixes for project build (error regarding RedHat.Spacing )
What issues does this pull request fix or reference?
Specify the version of the product this pull request applies to
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.