Skip to content

chore: promote Install to top-level Antora module #3102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gtrivedi88 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: promote Install to top-level Antora module #3102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a746a6
chore: promote Install to top-level Antora module
gtrivedi88 May 14, 2026
b997aba
chore: merge Plan content into Install module, retire Plan
gtrivedi88 May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ nav:
- modules/overview/nav.adoc
- modules/hosted-che/nav.adoc
- modules/end-user-guide/nav.adoc
- modules/install/nav.adoc
- modules/administration-guide/nav.adoc
- modules/extensions/nav.adoc
- modules/glossary/nav.adoc
Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/examples/proc_che-configuring-ingresses.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ spec:

.Additional resources

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

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
2 changes: 1 addition & 1 deletion ...nistration-guide/examples/snip_che-concealing-editors-additional-resources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.Additional resources

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

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

Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/examples/snip_che-supported-platforms.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ The following options are available for the local installation:

.Additional resources

* xref:installing-che.adoc[]
* xref:install:installing-che.adoc[]
2 changes: 1 addition & 1 deletion ...dministration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This section describes how to upgrade the `{prod-cli}` management tool.

.Prerequisites

* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[].
* `{prod-cli}`. See: xref:install:installing-the-chectl-management-tool.adoc[].

.Procedure

Expand Down
29 changes: 2 additions & 27 deletions modules/administration-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
.Administration Guide

* xref:security-best-practices.adoc[]
* xref:preparing-the-installation.adoc[]
** xref:supported-platforms.adoc[]
** xref:installing-the-chectl-management-tool.adoc[]
* xref:supported-platforms.adoc[]
** xref:architecture-overview.adoc[]
*** xref:server-components.adoc[]
**** xref:che-operator.adoc[]
Expand All @@ -14,31 +12,9 @@
**** xref:che-devfile-registry.adoc[]
**** xref:plugin-registry.adoc[]
*** xref:user-workspaces.adoc[]
** xref:calculating-che-resource-requirements.adoc[]
* xref:running-at-scale.adoc[]
// Install
* xref:installing-che.adoc[]
** Deploy on OpenShift
*** xref:proc_installing-che-on-openshift-using-cli.adoc[]
*** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
*** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
** Deploy on {kubernetes}
*** xref:installing-che-on-microsoft-azure.adoc[]
*** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
*** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[]
** Deploy locally
*** xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
*** xref:proc_installing-che-on-minikube.adoc[]
*** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]
** Deploy in a restricted environment
*** xref:proc_installing-che-in-a-restricted-environment.adoc[]
** xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
** xref:permissions-to-install-che.adoc[]
*** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
*** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
* xref:configuring-che.adoc[]
** xref:understanding-the-checluster-custom-resource.adoc[]
*** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
*** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
*** xref:checluster-custom-resource-fields-reference.adoc[]
** xref:configuring-namespace-provisioning.adoc[]
Expand Down Expand Up @@ -137,4 +113,3 @@
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
* xref:proc_uninstalling-che.adoc[]
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/che-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus
.Additional resources

* xref:understanding-the-checluster-custom-resource.adoc[]
* xref:installing-che.adoc[]
* xref:install:installing-che.adoc[]
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-che-hostname.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ spec:

.Additional resources

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

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
2 changes: 1 addition & 1 deletion ...es/administration-guide/pages/configuring-che-with-self-signed-certificate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ $ {orch-cli} label secret self-signed-certificate app.kubernetes.io/part-of=che.

.Additional resources

* xref:installing-che.adoc[]
* xref:install:installing-che.adoc[]
4 changes: 2 additions & 2 deletions modules/administration-guide/pages/configuring-storage-classes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Define a storage class name in the {prod-short} configuration to use the storage

Use CheCluster Custom Resource definition to define storage classes:

. 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[].
. 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[].
+
[source,yaml,subs="+quotes,+attributes"]
----
Expand All @@ -51,6 +51,6 @@ spec:

.Additional resources

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

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-storage-sizes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ per-workspace: 5Gi
[NOTE]
====

* You can set this field at installation. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
* You can set this field at installation. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].

* You can update this field on the command line. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].

Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-the-storage-strategy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The default storage strategy used in {prod-short} is `per-user`.
[NOTE]
====

* You can set this field at installation. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
* You can set this field at installation. See xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].

* You can update this field on the command line. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].

Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-workspace-target-namespace.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ spec:

.Additional resources

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

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-workspaces-nodeselector.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ Pass the name of this newly created `StorageClass` to {prod-short} through the `

.Additional resources

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

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
2 changes: 1 addition & 1 deletion ...loying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ sslCAInfo = /etc/config/che-git-tls-creds/certificate

.Additional resources

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

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

Expand Down
22 changes: 0 additions & 22 deletions modules/administration-guide/pages/installing-the-chectl-management-tool.adoc
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions modules/administration-guide/pages/permissions-to-install-che.adoc
View file
Open in desktop

This file was deleted.

16 changes: 0 additions & 16 deletions modules/administration-guide/pages/preparing-the-installation.adoc
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion modules/administration-guide/pages/provisioning-namespaces-in-advance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ metadata:

.Additional resources

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

* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
2 changes: 1 addition & 1 deletion .../administration-guide/pages/removing-user-data-in-compliance-with-the-gdpr.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ $ oc delete user <username>

* xref:managing-workloads-using-the-che-server-api.adoc[]
* xref:configuring-workspace-target-namespace.adoc[]
* xref:proc_uninstalling-che.adoc[]
* xref:install:proc_uninstalling-che.adoc[]
Loading
Loading