fix: JTBD compliance audit for Secure module#3159
Open
gtrivedi88 wants to merge 1 commit into
Open
Conversation
Align upstream Secure module with downstream JTBD standards and
CQA 2.1 editorial quality.
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 12 block titles to == headings (appear in page TOC)
- Add 3 JTBD orientation sections from downstream: "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" -> "Extension
security", "Secrets" -> "Credential and secret protection",
"Authentication" -> "Authentication and access verification"
Procedures:
- Remove generic persona snippet includes from all pages
- Delete unused partials/snip_persona-admin.adoc
- Fix cluster-roles example file: gerund title -> imperative,
add abstract, fix "Find out" -> "Determine", add .Verification
and .Additional resources
- Fix advanced-authorization: convert NOTE to continuation text,
add .Verification and .Additional resources, fix passive voice
- Fix GDPR page: hardcoded oc -> {orch-cli}, inline admonitions
-> block format, add .Verification, fix placeholder formatting
- Add source block bash language tags
Zero content loss verified via git diff against pre-PR eclipse-che#3134
state. All procedure steps, code blocks, and technical details
preserved.
Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://6a4ca2e59e3de4fb382c1d3c--eclipse-che-docs-pr.netlify.app 🎊 |
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
1 participant
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
Changes
Metadata and abstracts:
:description:attributes from gerunds to JTBD titles on all 5 pagesmanaging-identities-and-authorizations.adocStructure (security-best-practices.adoc):
.block titles to==headings so sections appear in the page TOC sidebar.Additional resourcessection with xrefs and external linksProcedures:
snip_persona-admin.adocincludes from all pages (guide-level callout + prerequisites serve as audience gate)partials/snip_persona-admin.adoc.Verificationand.Additional resources, fix "Find out" to "Determine"[NOTE]to continuation text, add.Verificationand.Additional resourcesocto{orch-cli}, inline admonitions to block format, add.VerificationZero content loss
Verified via
git diffagainst 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
Made with Cursor