fix: apply JTBD title to Install module#3149
Open
gtrivedi88 wants to merge 1 commit into
Open
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
|
🎊 Navigate the preview: https://6a564a291e6dc2d9b59d8f8d--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
gtrivedi88
force-pushed
the
fix-install-jtbd-title
branch
from
bc1162f to
9ff411a
Compare
gtrivedi88
force-pushed
the
fix-install-jtbd-title
branch
7 times, most recently
from
df7c7b5 to
5d80a8f
Compare
…DE terminology
- Apply JTBD user-goal titles to all shared Install pages (downstream parity)
- Sync :navtitle: and :description: with new titles
- Fix title-abstract verb consistency (Get/Get, Confirm/Confirm, Prepare/Prepare)
- Add "see Additional resources" bridge sentences in concept bodies so
readers know where to find related links (running-at-scale,
con_installation-overview)
- Move inline links out of concept body text into Additional resources
(running-at-scale: 15+ inline links removed, bridges added)
- Use {ocp} attribute instead of hardcoded "OpenShift Container Platform"
- JTBD section headings in con_installation-overview ("Which installation
method should I use?" / "Which deployment scenario matches my environment?")
- CDE terminology in con_next-steps-after-installation body bullets
- Convert inline admonitions to block-delimited format (NOTE:/IMPORTANT:
-> [NOTE]/[IMPORTANT] with ==== delimiters) in 4 files
- Add [role="_additional-resources"] where missing
- Remove em dashes from descriptions and abstracts
- Add admin access prerequisites where missing
- Fix operator namespace in verification: use --all-namespaces instead of
{prod-namespace} (operator pod runs in openshift-operators, not eclipse-che)
- Reorder nav.adoc: move FQDN topic between verification and next-steps
(post-install task, not an installation method)
Zero content loss: only metadata (titles, navtitles, descriptions, abstracts)
changed, bridge sentences added, inline links moved to AR, and verification
command fixed. All procedure steps, code blocks, and technical details
preserved verbatim.
Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
fix-install-jtbd-title
branch
from
5d80a8f to
42c71ae
Compare
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.
What does this pull request change?
JTBD audit of the Install module: titles, abstracts, prerequisites, bridge pattern, CDE terminology.
18 files changed across
modules/install/.Title updates (JTBD user-goal pattern)
Che installation overviewHow the installation worksVerify the Che installationConfirm Che is runningFind the fully qualified domain name (FQDN)Get the dashboard URL to share with your teamNext steps after installationPrepare Che for your teamUninstall CheRemove Che from your clusterChe scalabilityCan Che handle my team's scale?Calculate Che resource requirementsSize your cluster for CheInstall the chectl management toolSet up the chectl command-line toolUsing chectl to configure the CheCluster Custom Resource during installationCustomize settings during deploymentInstall Che in a restricted environment on OpenShiftDeploy in an air-gapped environmentInstall Che on OpenShift using CLIDeploy using the CLIInstall Che on OpenShift using the web consoleDeploy using the web consoleInstall Che on OpenShift with Keycloak as external identity providerDeploy using an external identity providerPermissions to install Che on OpenShift using CLIPermissions required for CLI installationPermissions to install Che on OpenShift using web consolePermissions required for web console installationBridge pattern (DITA link compliance)
running-at-scale.adoc: 15+ inline links removed from concept body, bridge sentences added ("see Additional resources"), links moved to[role="_additional-resources"]sectioncon_installation-overview.adoc:[role="_additional-resources"]added, deployment scenarios rewritten as user questionscon_next-steps-after-installation.adoc: CDE terminology applied, bullets rewrittenOther fixes
--all-namespacesinstead of-n {prod-namespace}(operator runs inopenshift-operators, noteclipse-che)nav.adoc: move FQDN topic between verification and next-steps (post-install task, not install method){ocp}attribute instead of hardcoded "OpenShift Container Platform":navtitle:and:description:with new titles on all pagesZero content loss. All procedure steps, code blocks, and technical details preserved verbatim.
Made with Cursor