Skip to content

fix: JTBD compliance audit for Secure module#3159

Open
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-secure-audit
Open

fix: JTBD compliance audit for Secure module#3159
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-secure-audit

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

  • Align Secure module with downstream JTBD standards and CQA 2.1 editorial quality
  • Fix metadata (descriptions, abstracts, verb consistency), structure (block titles to headings, JTBD sections), and procedures (verification, step verbs, admonition format)
  • Remove unused persona partial, inline cross-module snippet content

Changes

Metadata and abstracts:

  • Fix :description: attributes from gerunds to JTBD titles on all 5 pages
  • Fix title-abstract verb consistency (first verb in title matches first verb in abstract)
  • Fix self-referential abstract in managing-identities-and-authorizations.adoc

Structure (security-best-practices.adoc):

  • Convert 12 . block titles to == headings so sections appear in the page TOC sidebar
  • Add 3 JTBD orientation sections: "What is secure by default", "What you must configure", "What you can optionally harden"
  • Inline 4 cross-module snippet includes with equivalent text
  • Add .Additional resources section with xrefs and external links
  • Fix subsection headings: "Managing extensions" (gerund), "Secrets" (single word), "Authentication" (single word)

Procedures:

  • Remove generic snip_persona-admin.adoc includes from all pages (guide-level callout + prerequisites serve as audience gate)
  • Delete unused partials/snip_persona-admin.adoc
  • Fix cluster-roles example file: gerund title to imperative, add .Verification and .Additional resources, fix "Find out" to "Determine"
  • Fix advanced-authorization: convert [NOTE] to continuation text, add .Verification and .Additional resources
  • Fix GDPR page: hardcoded oc to {orch-cli}, inline admonitions to block format, add .Verification

Zero content loss

Verified via git diff against pre-PR #3134 state (08e76b97^). All procedure steps, code blocks, YAML examples, and technical details preserved. Only titles, abstracts, metadata, and structural formatting changed.

Test plan

  • Antora build passes with 0 errors
  • No new broken xrefs
  • All page TOC sidebars show correct section headings
  • Downstream equivalent already committed and validated (validate-refs 0 errors, Vale 0/0/0)

Made with Cursor

@gtrivedi88
gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 7, 2026 06:48
@gtrivedi88
gtrivedi88 requested a review from azatsarynnyy July 7, 2026 06:48
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

🎊 Navigate the preview: https://6a583f587c26a3e5415614ba--eclipse-che-docs-pr.netlify.app 🎊

@gtrivedi88
gtrivedi88 force-pushed the jtbd-secure-audit branch 3 times, most recently from a9ff17d to af965a4 Compare July 16, 2026 02:02
Align upstream Secure module with downstream JTBD standards and
CQA 2.1 editorial quality. Address Secure hierarchy review gaps.

Metadata and abstracts:
- Fix :description: attributes (gerunds -> JTBD titles)
- Fix title-abstract verb consistency on all pages
- Fix self-referential abstract in managing-identities page

Structure (security-best-practices.adoc):
- Convert block titles to == headings (appear in page TOC)
- Add JTBD orientation sections and bridge sentences
- Remove duplicated advancedAuthorization YAML example
- Strengthen thin credentials and trusted-Git subsections
- Rename weak H2s (gateway, air-gapped, IDE extensions, namespace resources)
- Add [role="_additional-resources"] and cross-module xrefs
- Plan-style nav: unlinked job group for access-control procedures

Procedures:
- Remove generic persona snippet includes
- Delete unused partials/snip_persona-admin.adoc
- Fix cluster-roles example: kubectl -> {orch-cli}, Verification, AR
- Fix advanced-authorization and GDPR pages

Zero content loss for procedure steps, RBAC table, and SCC examples.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant