chore: promote Secure to top-level Antora module (JTBD Phase 2)#3134
Merged
Conversation
|
🎊 Navigate the preview: https://6a479f349ff16064a6c397fc--eclipse-che-docs-pr.netlify.app 🎊 |
ibuziuk
reviewed
Jul 1, 2026
8a048b6 to
ae0988b
Compare
ibuziuk
reviewed
Jul 2, 2026
|
|
||
| [id="configuring-oauth-for-git-providers"] | ||
| = Configuring OAuth for Git providers | ||
| = Give developers credential-free Git access |
Member
There was a problem hiding this comment.
tbh, I'm not sure this is the best title, and it might be confusing. Can we leave OAuth as factually correct?
ibuziuk
reviewed
Jul 2, 2026
| @@ -0,0 +1,6 @@ | |||
| .Secure | |||
| * xref:security-best-practices.adoc[] | |||
| * xref:managing-identities-and-authorizations.adoc[] | |||
Member
There was a problem hiding this comment.
should it be moved out of security ^ ?
Contributor
Author
There was a problem hiding this comment.
@ibuziuk Just want to confirm when you say we need to move out of security. You mean flattening the strcuture or move it to Admin guide.
The reason why it is in Secure is because for a user Identity management (RBAC, cluster roles, authorization) is kind of a security concern.
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>
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>
…at.Spacing errors
- Per-page admin persona callout via discover:partial$snip_persona-admin.adoc in all 5 secure pages Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…onflict) 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>
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>
4ba0069 to
d844c49
Compare
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>
878ff2c to
6caa91e
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
2376582 to
5627d35
Compare
ibuziuk
approved these changes
Jul 3, 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
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
modules/secure/Changes
modules/secure/with nav.adoc, 12 pagesantora.ymlwith secure navTest plan
Made with Cursor