Skip to content

Commit 55dc6a0

Browse files
gtrivedi88claude
andauthored
chore: restructure Install category with JTBD and CQA 2.1 compliance (#3077) (#3100)
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>
1 parent 1a62f6c commit 55dc6a0

32 files changed

Lines changed: 657 additions & 616 deletions

File tree

modules/administration-guide/examples/snip_che-installing-che.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ The installation method depends on the target platform and the environment restr
1010

1111
You can deploy only one instance of {prod-short} per cluster.
1212

13-
* xref:installing-che-on-openshift-using-cli.adoc[]
14-
* xref:installing-che-on-openshift-using-the-web-console.adoc[]
15-
* xref:installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
16-
* xref:installing-che-in-a-restricted-environment.adoc[]
13+
* xref:proc_installing-che-on-openshift-using-cli.adoc[]
14+
* xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
15+
* xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
16+
* xref:proc_installing-che-in-a-restricted-environment.adoc[]
1717
* xref:installing-che-on-microsoft-azure.adoc[]
1818
* xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
1919
2020
.Installing {prod-short} on a local single-node cluster
2121

22-
Single-node clusters are suited only for testing or development. Do *not* use such clusters to run {prod-short} for organizations or developer teams.
22+
Single-node clusters are suited only for testing or development. Do not use such clusters to run {prod-short} for organizations or developer teams.
2323

24-
* xref:installing-che-on-red-hat-openshift-local.adoc[]
25-
* xref:installing-che-on-minikube.adoc[]
26-
* xref:installing-che-on-minikube-keycloak-oidc.adoc[]
24+
* xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
25+
* xref:proc_installing-che-on-minikube.adoc[]
26+
* xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]

modules/administration-guide/nav.adoc

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,26 @@
1616
*** xref:user-workspaces.adoc[]
1717
** xref:calculating-che-resource-requirements.adoc[]
1818
* xref:running-at-scale.adoc[]
19+
// Install
1920
* xref:installing-che.adoc[]
20-
** xref:installing-che-on-the-virtual-kubernetes-cluster.adoc[]
21-
** xref:installing-che-in-the-cloud.adoc[]
22-
*** xref:installing-che-on-openshift-using-cli.adoc[]
23-
*** xref:installing-che-on-openshift-using-the-web-console.adoc[]
24-
*** xref:installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
25-
*** xref:installing-che-in-a-restricted-environment.adoc[]
21+
** Deploy on OpenShift
22+
*** xref:proc_installing-che-on-openshift-using-cli.adoc[]
23+
*** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
24+
*** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
25+
** Deploy on {kubernetes}
2626
*** xref:installing-che-on-microsoft-azure.adoc[]
2727
*** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
28-
** xref:installing-che-locally.adoc[]
29-
*** xref:installing-che-on-red-hat-openshift-local.adoc[]
30-
*** xref:installing-che-on-minikube.adoc[]
31-
*** xref:installing-che-on-minikube-keycloak-oidc.adoc[]
32-
** xref:finding-the-fully-qualified-domain-name-fqdn.adoc[]
28+
*** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[]
29+
** Deploy locally
30+
*** xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
31+
*** xref:proc_installing-che-on-minikube.adoc[]
32+
*** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]
33+
** Deploy in a restricted environment
34+
*** xref:proc_installing-che-in-a-restricted-environment.adoc[]
35+
** xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
3336
** xref:permissions-to-install-che.adoc[]
34-
*** xref:permissions-to-install-che-on-openshift-using-cli.adoc[]
35-
*** xref:permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
37+
*** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
38+
*** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
3639
* xref:configuring-che.adoc[]
3740
** xref:understanding-the-checluster-custom-resource.adoc[]
3841
*** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
@@ -134,4 +137,4 @@
134137
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
135138
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
136139
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
137-
* xref:uninstalling-che.adoc[]
140+
* xref:proc_uninstalling-che.adoc[]

modules/administration-guide/pages/finding-the-fully-qualified-domain-name-fqdn.adoc

Lines changed: 0 additions & 26 deletions
This file was deleted.

modules/administration-guide/pages/installing-che-in-a-restricted-environment.adoc

Lines changed: 0 additions & 41 deletions
This file was deleted.

modules/administration-guide/pages/installing-che-in-the-cloud.adoc

Lines changed: 0 additions & 26 deletions
This file was deleted.

modules/administration-guide/pages/installing-che-locally.adoc

Lines changed: 0 additions & 24 deletions
This file was deleted.

modules/administration-guide/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
:_content-type: ASSEMBLY
2-
:description: Installing {prod-short} on {eks}
3-
:keywords: overview, installing-{prod-id-short}-on-amazon-elastic-kubernetes-service.adoc
4-
:navtitle: Installing {prod-short} on {eks}
2+
:description: To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster with DNS, TLS certificates, and Keycloak as the OIDC identity provider.
3+
:keywords: overview, installing-{prod-id-short}-on-amazon-elastic-kubernetes-service
4+
:navtitle: Install {prod-short} on {eks}
55

6-
[id="installing-{prod-id-short}-on-amazon-elastic-kubernetes-service.adoc"]
7-
= Installing {prod-short} on {eks}
6+
[id="installing-{prod-id-short}-on-amazon-elastic-kubernetes-service"]
7+
= Install {prod-short} on {eks}
88

9-
{eks} (Amazon EKS) is a managed {kubernetes} service to run {kubernetes} in the AWS cloud and on-premises data centers.
10-
11-
Follow the instructions below to install and enable {prod-short} on {eks-short}.
9+
[role="_abstract"]
10+
To provide cloud development environments on AWS, deploy {prod-short} on an Amazon EKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider.
1211

1312
.Prerequisites
1413

15-
* `helm`: The package manager for {kubernetes}. See: link:https://helm.sh/docs/intro/install/[Installing Helm].
14+
* You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm].
1615

17-
* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[].
16+
* You have `{prod-cli}` installed. See xref:installing-the-chectl-management-tool.adoc[].
1817

19-
* `aws`: The AWS Command Line Interface. See: link:https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html[AWS CLI install and update instructions]
18+
* You have the `aws` CLI installed. See link:https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html[AWS CLI install and update instructions].
2019

21-
* `eksctl`: The Command Line Interface for creating and managing {kubernetes} clusters on {eks-short}. See: link:https://eksctl.io/installation/[Installing eksctl]
20+
* You have `eksctl` installed. See link:https://eksctl.io/installation/[Installing eksctl].
2221

2322
include::partial$configuring-environment-variables-for-amazon-elastic-kubernetes-service.adoc[leveloffset=+1]
2423

modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
:_content-type: ASSEMBLY
2-
:description: Installing {prod-short} on Microsoft Azure
2+
:description: To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster with DNS, TLS certificates, and Keycloak as the OIDC identity provider.
33
:keywords: overview, installing-che-on-microsoft-azure
4-
:navtitle: Installing {prod-short} on Microsoft Azure
4+
:navtitle: Install {prod-short} on Microsoft Azure
55

66
[id="installing-{prod-id-short}-on-microsoft-azure"]
7-
= Installing {prod-short} on Microsoft Azure
7+
= Install {prod-short} on Microsoft Azure
88

9-
Microsoft Azure is a cloud computing service for building, testing, deploying, and managing applications and services through Microsoft-managed data centers.
10-
11-
Follow the instructions below to install and enable {prod-short} on Microsoft Azure.
9+
[role="_abstract"]
10+
To provide cloud development environments on Microsoft Azure, deploy {prod-short} on an AKS cluster by configuring DNS, TLS certificates, and Keycloak as the OIDC identity provider.
1211

1312
.Prerequisites
1413

15-
* `helm`: The package manager for {kubernetes}. See: link:https://helm.sh/docs/intro/install/[Installing Helm].
14+
* You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm].
1615

17-
* `az`: The Microsoft Azure CLI command line tool. See: link:https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest[How to install Microsoft Azure CLI].
16+
* You have the `az` CLI installed. See link:https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest[How to install Microsoft Azure CLI].
1817

19-
* `kubelogin`: The credential plugin. See: link:https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[How to install kubelogin].
18+
* You have `kubelogin` installed. See link:https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[How to install kubelogin].
2019

2120
include::partial$proc_preparing-microsoft-azure-for-installing-che.adoc[leveloffset=+1]
2221

modules/administration-guide/pages/installing-che-on-minikube.adoc

Lines changed: 0 additions & 54 deletions
This file was deleted.

modules/administration-guide/pages/installing-che-on-openshift-using-cli.adoc

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)