Skip to content

chore: Plan as top-level Antora module (JTBD) #3162

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: Plan as top-level Antora module (JTBD) #3162

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
ec3d5bd
chore: Plan as top-level Antora module + Optimize etcd procedures (JTBD)
gtrivedi88 Jul 27, 2026
4cd0bdf
fix: resolve rebase conflict and clean up Plan module references
gtrivedi88 Sep 17, 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
6 changes: 6 additions & 0 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,9 @@ RedHat.ConfigMap = NO
RedHat.Slash = NO
RedHat.Spacing = NO
RedHat.Spelling = NO

# The DevWorkspaceOperatorConfig custom resource and its example YAML manifest
# must use the literal Kind and metadata name from the DevWorkspace Operator API,
# which legitimately contain the substring "devworkspace".
[modules/optimize/pages/configuring-automatic-cleanup-of-inactive-workspaces.adoc]
CheDocs.Attributes = NO
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 @@ -6,6 +6,7 @@ prerelease: true
start_page: discover:what-is-che.adoc
nav:
- modules/discover/nav.adoc
- modules/plan/nav.adoc
- modules/install/nav.adoc
- modules/get-started-admin/nav.adoc
- modules/get-started-user/nav.adoc
Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/partials/proc_configuring-routes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can configure labels, annotations, and domains for OpenShift Route to work w

* An active `oc` session with administrative permissions to the OpenShift cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI].

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

.Procedure

Expand Down
1 change: 0 additions & 1 deletion modules/discover/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,4 @@
*** xref:che-devfile-registry.adoc[]
*** xref:plugin-registry.adoc[]
** xref:user-workspaces.adoc[]
* xref:supported-platforms.adoc[]
* xref:roles-and-tasks.adoc[]
2 changes: 1 addition & 1 deletion modules/discover/pages/what-is-che.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ See the development link:https://github.com/eclipse/che/wiki/Roadmap[roadmap] on
.Additional resources

* xref:architecture-overview.adoc[]
* xref:supported-platforms.adoc[]
* xref:plan:supported-platforms.adoc[]
6 changes: 0 additions & 6 deletions modules/install/examples/snip_che-running-at-scale-calculate-resources.adoc
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions modules/install/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
* xref:con_installation-overview.adoc[]
// Requirements
* Requirements
** xref:administration-guide:supported-platforms.adoc[]
** xref:calculating-che-resource-requirements.adoc[]
** xref:running-at-scale.adoc[]
** xref:installing-the-chectl-management-tool.adoc[]
** xref:plan:supported-platforms.adoc[]
** xref:plan:calculating-che-resource-requirements.adoc[]
** xref:plan:cluster-capacity-limits.adoc[]
** xref:plan:installing-the-chectl-management-tool.adoc[]
// Installing
* Deploy using GitOps
** xref:proc_deploying-che-using-gitops.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion modules/install/pages/installing-che-on-amazon-elastic-kubernetes-service.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ include::partial$snip_persona-admin.adoc[]

* You have `helm` installed. See link:https://helm.sh/docs/intro/install/[Installing Helm].

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

* 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].

Expand Down
2 changes: 1 addition & 1 deletion modules/install/pages/proc_installing-che-on-minikube-keycloak-oidc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Single-node {kubernetes} clusters are suited only for testing or development. Do

* You have `{orch-cli}` installed. See link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `{orch-cli}`].

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

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/install/pages/proc_installing-che-on-minikube.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Single-node {kubernetes} clusters are suited only for testing or development. Do

* You have `{orch-cli}` installed. See link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `{orch-cli}`].

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

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/install/pages/proc_installing-che-on-openshift-using-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ include::partial$snip_persona-admin.adoc[]

* You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI].

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

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/install/pages/proc_installing-che-on-red-hat-openshift-local.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include::partial$snip_persona-admin.adoc[]

* You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI].

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

* You have a running instance of {rh-os-local}. See link:https://developers.redhat.com/products/openshift-local/overview[{rh-os-local} overview].

Expand Down
6 changes: 3 additions & 3 deletions modules/install/pages/proc_installing-che-on-the-virtual-kubernetes-cluster.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ include::partial$snip_persona-admin.adoc[]

* You have `kubelogin` installed. See link:https://github.com/int128/kubelogin[Installing kubelogin].

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

* You have an active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster.

Expand All @@ -41,7 +41,7 @@ Check your {kubernetes} provider documentation on how to install it.
[TIP]
====
Use the following command to install link:https://docs.nginx.com/nginx-ingress-controller/[NGINX Ingress Controller]
on Azure Kubernetes Service cluster:
on Azure {kubernetes} Service cluster:
[source,bash,subs="attributes+"]
----
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
Expand Down Expand Up @@ -566,7 +566,7 @@ get-token,\
[TIP]
====
Use the following command to install link:https://docs.nginx.com/nginx-ingress-controller/[NGINX Ingress Controller]
on Azure Kubernetes Service cluster:
on Azure {kubernetes} Service cluster:
[source,bash,subs="attributes+"]
----
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
Expand Down
4 changes: 2 additions & 2 deletions modules/install/pages/proc_uninstalling-che.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Uninstalling {prod-short} removes all {prod-short}-related user data.

* You have an active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI].

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

.Procedure

Expand Down Expand Up @@ -58,4 +58,4 @@ The expected output is `NotFound`.
[role="_additional-resources"]
.Additional resources

* xref:installing-the-chectl-management-tool.adoc[]
* xref:plan:installing-the-chectl-management-tool.adoc[]
Loading
Loading