Skip to content

Commit 3e0e348

Browse files
gtrivedi88claudecursoragent
authored
chore: promote Install to top-level Antora module (#3102)
* 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> * chore: merge Plan content into Install module, retire Plan Move calculating-che-resource-requirements, running-at-scale, and installing-the-chectl-management-tool from administration-guide into the install module. This merges what was planned as a separate Plan module (PR #3099) directly into Install, matching the downstream decision to retire the Plan guide. - Move 3 pages, 4 examples, 1 image to modules/install/ - Add running-at-scale to install/nav.adoc Requirements section - Update admin-guide nav to remove moved entries - Convert cross-module xrefs: admin-guide refs to install become local - Add plan: page-aliases for backward-compatible redirects Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 2a817c1 commit 3e0e348

81 files changed

Lines changed: 514 additions & 401 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.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
From 3a08d09838b9f195c37b1621f8e5ca99cda998ad Mon Sep 17 00:00:00 2001
2+
From: Gaurav Trivedi <gtrivedi@redhat.com>
3+
Date: Tue, 16 Jun 2026 19:59:42 +0530
4+
Subject: [PATCH] fix: Make Discover the first top-level section per SME
5+
feedback
6+
MIME-Version: 1.0
7+
Content-Type: text/plain; charset=UTF-8
8+
Content-Transfer-Encoding: 8bit
9+
10+
Addresses SME feedback from ibuziuk on PR #3098:
11+
- Move Discover to first position in navigation
12+
- Include 'Introduction to Che' and 'Eclipse Che hosted by Red Hat' in Discover section
13+
- Remove redundant overview and hosted-che from main nav (content accessible via Discover)
14+
- Logical user flow: Discover → Use → Administer
15+
16+
This creates a better user journey where users first discover what Eclipse Che
17+
is and explore hosted options before diving into detailed architecture.
18+
19+
Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
20+
---
21+
antora.yml | 2 --
22+
modules/discover/nav.adoc | 2 ++
23+
2 files changed, 2 insertions(+), 2 deletions(-)
24+
25+
diff --git a/antora.yml b/antora.yml
26+
index 805ff274..f40b9f10 100644
27+
--- a/antora.yml
28+
+++ b/antora.yml
29+
@@ -5,8 +5,6 @@ version: next
30+
prerelease: true
31+
start_page: overview:introduction-to-eclipse-che.adoc
32+
nav:
33+
- - modules/overview/nav.adoc
34+
- - modules/hosted-che/nav.adoc
35+
- modules/discover/nav.adoc
36+
- modules/end-user-guide/nav.adoc
37+
- modules/administration-guide/nav.adoc
38+
diff --git a/modules/discover/nav.adoc b/modules/discover/nav.adoc
39+
index d21c3f64..f6f27c59 100644
40+
--- a/modules/discover/nav.adoc
41+
+++ b/modules/discover/nav.adoc
42+
@@ -1,5 +1,7 @@
43+
.Discover
44+
45+
+* xref:overview:introduction-to-eclipse-che.adoc[]
46+
+* xref:hosted-che:hosted-che.adoc[]
47+
* xref:architecture-overview.adoc[]
48+
** xref:server-components.adoc[]
49+
*** xref:che-operator.adoc[]
50+
--
51+
2.54.0
52+

antora.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ version: next
55
prerelease: true
66
start_page: overview:introduction-to-eclipse-che.adoc
77
nav:
8+
- modules/overview/nav.adoc
89
- modules/discover/nav.adoc
10+
- modules/install/nav.adoc
911
- modules/end-user-guide/nav.adoc
1012
- modules/administration-guide/nav.adoc
1113
- modules/extensions/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-upgrading-the-chectl-management-tool.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section describes how to upgrade the `{prod-cli}` management tool.
44

55
.Prerequisites
66

7-
* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[].
7+
* `{prod-cli}`. See: xref:install:installing-the-chectl-management-tool.adoc[].
88
99
.Procedure
1010

modules/administration-guide/nav.adoc

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,9 @@
11
.Administration Guide
22

33
* xref:security-best-practices.adoc[]
4-
* xref:preparing-the-installation.adoc[]
5-
** xref:installing-the-chectl-management-tool.adoc[]
6-
** xref:calculating-che-resource-requirements.adoc[]
7-
* xref:running-at-scale.adoc[]
8-
// Install
9-
* xref:installing-che.adoc[]
10-
** Deploy on OpenShift
11-
*** xref:proc_installing-che-on-openshift-using-cli.adoc[]
12-
*** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
13-
*** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
14-
** Deploy on {kubernetes}
15-
*** xref:installing-che-on-microsoft-azure.adoc[]
16-
*** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
17-
*** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[]
18-
** Deploy locally
19-
*** xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
20-
*** xref:proc_installing-che-on-minikube.adoc[]
21-
*** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]
22-
** Deploy in a restricted environment
23-
*** xref:proc_installing-che-in-a-restricted-environment.adoc[]
24-
** xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
25-
** xref:permissions-to-install-che.adoc[]
26-
*** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
27-
*** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
284
* xref:configuring-che.adoc[]
295
** xref:understanding-the-checluster-custom-resource.adoc[]
30-
*** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
6+
*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
317
*** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
328
*** xref:checluster-custom-resource-fields-reference.adoc[]
339
** xref:configuring-namespace-provisioning.adoc[]
@@ -128,4 +104,3 @@
128104
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
129105
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
130106
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
131-
* xref:proc_uninstalling-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)