Skip to content

Commit 5362c7a

Browse files
gtrivedi88claude
andcommitted
chore: create Discover category with JTBD and CQA 2.1 compliance
Move architecture overview, server components (7 sub-pages), user workspaces, and supported platforms from the Administration Guide into a new top-level Discover module. This is the first step in the JTBD category restructure — promoting evaluation and discovery content out of the monolithic Administration Guide. Changes: - Create modules/discover/ with pages, examples, and images - Add WHY-first abstracts to all 11 pages ("To [purpose], [action]") - Add page-aliases for backward-compatible URLs from admin-guide - Update antora.yml: register discover nav, move architecture diagram collector to discover module - Update all cross-module xrefs in admin-guide, overview modules - Remove Discover entries from administration-guide nav.adoc Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c3a8ac9 commit 5362c7a

31 files changed

Lines changed: 179 additions & 148 deletions

antora.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ start_page: overview:introduction-to-eclipse-che.adoc
77
nav:
88
- modules/overview/nav.adoc
99
- modules/hosted-che/nav.adoc
10+
- modules/discover/nav.adoc
1011
- modules/end-user-guide/nav.adoc
1112
- modules/administration-guide/nav.adoc
1213
- modules/extensions/nav.adoc
@@ -133,6 +134,6 @@ ext:
133134
- run:
134135
command: ./tools/create_architecture_diagrams.py
135136
scan:
136-
base: modules/administration-guide/images/architecture/
137+
base: modules/discover/images/architecture/
137138
dir: build/collector/architecture-diagrams
138139
files: '*.png'

modules/administration-guide/nav.adoc

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,7 @@
22

33
* xref:security-best-practices.adoc[]
44
* xref:preparing-the-installation.adoc[]
5-
** xref:supported-platforms.adoc[]
65
** xref:installing-the-chectl-management-tool.adoc[]
7-
** xref:architecture-overview.adoc[]
8-
*** xref:server-components.adoc[]
9-
**** xref:che-operator.adoc[]
10-
**** xref:devworkspace-operator.adoc[]
11-
**** xref:gateway.adoc[]
12-
**** xref:dashboard.adoc[]
13-
**** xref:che-server.adoc[]
14-
**** xref:che-devfile-registry.adoc[]
15-
**** xref:plugin-registry.adoc[]
16-
*** xref:user-workspaces.adoc[]
176
** xref:calculating-che-resource-requirements.adoc[]
187
* xref:running-at-scale.adoc[]
198
// Install

modules/administration-guide/pages/architecture-overview.adoc

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Persistent volume claims facts:
2222

2323
* {prod-short} does not create persistent volumes in the infrastructure.
2424
* {prod-short} uses persistent volume claims (PVC) to mount persistent volumes.
25-
* The xref:devworkspace-operator.adoc[Dev Workspace operator] creates persistent volume claims.
25+
* The xref:discover:devworkspace-operator.adoc[Dev Workspace operator] creates persistent volume claims.
2626
+
2727
Define a storage class name in the {prod-short} configuration to use the storage classes feature in the {prod-short} PVC.
2828

modules/administration-guide/pages/devworkspace-backup-integrated-openshift-registry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ config:
3131
schedule: '0 */4 * * *' # cron expression with backup frequency
3232
imagePullPolicy: Always
3333
----
34-
<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:devworkspace-operator.adoc[{devworkspace} operator overview].
34+
<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:discover:devworkspace-operator.adoc[{devworkspace} operator overview].
3535
<2> The `--insecure` flag can be required depending on the integrated registry's routing configuration.
3636

3737
**Note:** The `path` field must contain the URL to your OpenShift integrated registry given by the cluster.

modules/administration-guide/pages/devworkspace-backup-regular-oci-registry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ config:
3131
schedule: '0 */4 * * *'
3232
imagePullPolicy: Always
3333
----
34-
<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:devworkspace-operator.adoc[{devworkspace} operator overview].
34+
<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:discover:devworkspace-operator.adoc[{devworkspace} operator overview].
3535

3636
The `authSecret` must be named `devworkspace-backup-registry-auth`. It must reference a {kubernetes} Secret of type `kubernetes.io/dockerconfigjson` that contains credentials to access the registry.
3737
The secret should be created in the installation {namespace} for the {devworkspace} operator.

modules/administration-guide/pages/preparing-the-installation.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
[id="preparing-the-installation"]
88
= Preparing the installation
99

10-
To prepare a {prod-short} installation, learn about the {prod-short} ecosystem and deployment constraints:
10+
To prepare a {prod-short} installation, review the platform requirements and deployment tools:
1111

12-
* xref:supported-platforms.adoc[]
12+
* xref:discover:supported-platforms.adoc[]
13+
* xref:discover:architecture-overview.adoc[]
1314
* xref:installing-the-chectl-management-tool.adoc[]
14-
* xref:architecture-overview.adoc[]
1515
* xref:calculating-che-resource-requirements.adoc[]
1616
* xref:understanding-the-checluster-custom-resource.adoc[]

modules/administration-guide/pages/server-components.adoc

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

modules/administration-guide/pages/supported-platforms.adoc

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

modules/administration-guide/partials/snip_defining-dwo-namespace-for-backups.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ spec:
1818
value: $OPERATOR_INSTALL_NAMESPACE <1>
1919
name: che-dashboard
2020
----
21-
<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:devworkspace-operator.adoc[{devworkspace} operator overview].
21+
<1> For Red Hat OpenShift, the default installation namespace for the {devworkspace} operator is `openshift-operators`. See the xref:discover:devworkspace-operator.adoc[{devworkspace} operator overview].
2222
====

0 commit comments

Comments
 (0)