Skip to content

chore: backport Install category JTBD restructure to 7.117.x (#3077)#3100

Merged
gtrivedi88 merged 1 commit into
eclipse-che:7.117.xfrom
gtrivedi88:backport-3077-to-7.117.x
May 14, 2026
Merged

chore: backport Install category JTBD restructure to 7.117.x (#3077)#3100
gtrivedi88 merged 1 commit into
eclipse-che:7.117.xfrom
gtrivedi88:backport-3077-to-7.117.x

Conversation

@gtrivedi88
Copy link
Copy Markdown
Contributor

Summary

Changes (from #3077)

  • Restructured nav.adoc Install section: Deploy on OpenShift, Deploy on Kubernetes, Deploy locally, Deploy in a restricted environment
  • Renamed files with content-type prefixes (proc_, ref_)
  • Added :page-aliases: for backward-compatible URL redirects
  • Applied CQA 2.1: imperative titles, WHY-first abstracts, [source,bash], user-first prerequisites, .Verification sections
  • Hardcoded "OpenShift" in titles/navtitles of OpenShift-specific procedures
  • Removed unused partial (snip_che-setting-up-ansible-sample.adoc)

Test plan

  • Antora build succeeds with no broken xrefs
  • detect-unused-content.sh passes
  • Vale linting passes
  • Old URLs redirect via :page-aliases:

🤖 Generated with Claude Code

…clipse-che#3077)

Reorganize the Install section of the Administration Guide using
Jobs-to-Be-Done methodology and Red Hat CQA 2.1 editorial standards.

Changes:
- Rename 14 install files with CQA content type prefixes (proc_, ref_)
- Apply CQA to 8 shared files using downstream CQA-compliant content
- Apply CQA from scratch to 6 upstream-only files
- Restructure nav.adoc into job-based groups: Deploy on OpenShift,
  Deploy on Kubernetes, Deploy locally, Deploy in restricted environment
- Rewrite all abstracts with WHY-first JTBD framing
- Fix titles to imperative form, prerequisites to user-first declarative
- Standardize source blocks, verification sections, additional resources
- Add page-aliases for all renamed files to preserve backward compat
- Remove thin wrapper pages (installing-che-in-the-cloud, installing-che-locally)
- Update all xrefs across nav.adoc, snippets, and referencing pages

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners May 14, 2026 14:35
@gtrivedi88 gtrivedi88 requested review from svor and removed request for a team May 14, 2026 14:35
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

Click here to review and test in web IDE: Contribute

@gtrivedi88 gtrivedi88 merged commit 55dc6a0 into eclipse-che:7.117.x May 14, 2026
6 checks passed
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