Skip to content

Commit 58dfba6

Browse files
gtrivedi88claude
andcommitted
chore: promote Install to top-level Antora module
Move all installation pages, partials, and examples from administration-guide to a new modules/install/ module, matching the downstream JTBD category structure. Create installation overview, verification, and next-steps pages. Update all cross-module xrefs and includes across admin-guide, overview, and end-user-guide. Delete dissolved wrapper pages (preparing-the-installation, permissions-to-install-che). Register discover, plan, and install module navs in antora.yml. Depends on: PR #3098 (Discover), PR #3099 (Plan) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 95402ae commit 58dfba6

68 files changed

Lines changed: 212 additions & 115 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

antora.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ nav:
88
- modules/overview/nav.adoc
99
- modules/hosted-che/nav.adoc
1010
- modules/end-user-guide/nav.adoc
11+
- modules/discover/nav.adoc
12+
- modules/plan/nav.adoc
13+
- modules/install/nav.adoc
1114
- modules/administration-guide/nav.adoc
1215
- modules/extensions/nav.adoc
1316
- modules/glossary/nav.adoc

modules/administration-guide/examples/proc_che-configuring-ingresses.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ spec:
2626

2727
.Additional resources
2828

29-
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
29+
* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
3030

3131
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

modules/administration-guide/examples/snip_che-concealing-editors-additional-resources.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.Additional resources
44

5-
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
5+
* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
66
77
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
88

modules/administration-guide/examples/snip_che-supported-platforms.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ The following options are available for the local installation:
2323
2424
.Additional resources
2525

26-
* xref:installing-che.adoc[]
26+
* xref:install:installing-che.adoc[]

modules/administration-guide/nav.adoc

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,9 @@
1616
*** xref:user-workspaces.adoc[]
1717
** xref:calculating-che-resource-requirements.adoc[]
1818
* xref:running-at-scale.adoc[]
19-
// Install
20-
* xref:installing-che.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}
26-
*** xref:installing-che-on-microsoft-azure.adoc[]
27-
*** xref:installing-che-on-amazon-elastic-kubernetes-service.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[]
36-
** xref:permissions-to-install-che.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[]
3919
* xref:configuring-che.adoc[]
4020
** xref:understanding-the-checluster-custom-resource.adoc[]
41-
*** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
21+
*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
4222
*** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
4323
*** xref:checluster-custom-resource-fields-reference.adoc[]
4424
** xref:configuring-namespace-provisioning.adoc[]
@@ -137,4 +117,3 @@
137117
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
138118
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
139119
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
140-
* xref:proc_uninstalling-che.adoc[]

modules/administration-guide/pages/che-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus
2929
.Additional resources
3030

3131
* xref:understanding-the-checluster-custom-resource.adoc[]
32-
* xref:installing-che.adoc[]
32+
* xref:install:installing-che.adoc[]

modules/administration-guide/pages/configuring-che-hostname.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ spec:
6666

6767
.Additional resources
6868

69-
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
69+
* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
7070

7171
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

modules/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ $ {orch-cli} label secret self-signed-certificate app.kubernetes.io/part-of=che.
6363

6464
.Additional resources
6565

66-
* xref:installing-che.adoc[]
66+
* xref:install:installing-che.adoc[]

modules/administration-guide/pages/configuring-storage-classes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Define a storage class name in the {prod-short} configuration to use the storage
3030

3131
Use CheCluster Custom Resource definition to define storage classes:
3232

33-
. Define storage class names: configure the `CheCluster` Custom Resource, and install {prod-short}. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
33+
. Define storage class names: configure the `CheCluster` Custom Resource, and install {prod-short}. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
3434
+
3535
[source,yaml,subs="+quotes,+attributes"]
3636
----
@@ -51,6 +51,6 @@ spec:
5151

5252
.Additional resources
5353

54-
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
54+
* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
5555

5656
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

modules/administration-guide/pages/configuring-storage-sizes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ per-workspace: 5Gi
3535
[NOTE]
3636
====
3737
38-
* You can set this field at installation. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
38+
* You can set this field at installation. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
3939
4040
* You can update this field on the command line. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
4141

0 commit comments

Comments
 (0)