chore: Plan as top-level Antora module (JTBD) - #3162
Open
gtrivedi88 wants to merge 2 commits into
Open
gtrivedi88 wants to merge 2 commits into
gtrivedi88 wants to merge 2 commits into
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
July 14, 2026 12:38
|
⚡️ Deploying pull request preview... |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
gtrivedi88
changed the title
gtrivedi88
force-pushed
the
jtbd-plan-category
branch
3 times, most recently
from
July 16, 2026 01:38
cbf98bf to
44cf014
Compare
gtrivedi88
force-pushed
the
jtbd-plan-category
branch
2 times, most recently
from
July 27, 2026 19:06
31e52f5 to
7e404a6
Compare
gtrivedi88
force-pushed
the
jtbd-plan-category
branch
6 times, most recently
from
July 27, 2026 19:46
dc3c03a to
e2958f0
Compare
Plan module: - Create modules/plan/ with nav, pages, examples, and images - Move 4 pages from admin-guide and install modules - Break running-at-scale.adoc into 3 focused concept pages: cluster-capacity-limits, etcd-storage-limits, multi-cluster-deployments - Add page-aliases for backward-compatible URLs Optimize module: - Add 3 procedure pages to reduce etcd storage pressure: configuring-automatic-cleanup-of-inactive-workspaces (DevWorkspace Pruner) disabling-workspace-ca-bundle-mount (ca-certs-merged ConfigMaps) disabling-copied-csvs (OLM namespace-scoped CSV copies) - Update optimize/nav.adoc with "Reduce etcd pressure at scale" section Plan nav links to Optimize procedures via cross-module xrefs. Zero content loss. Matches downstream devspaces-documentation structure. Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-plan-category
branch
6 times, most recently
from
September 17, 2026 07:13
c19abbb to
4ccaa34
Compare
Rebased jtbd-plan-category onto main to pick up 18 commits merged since this PR was last updated (GitOps install procedures, Install JTBD audit, Troubleshoot/Discover/Optimize promotions, dashboard Swagger route fix). Conflict resolution: - modules/install/pages/running-at-scale.adoc: modify/delete conflict. GitOps (eclipse-che#3141) added one line (include::partial$snip_persona-admin. adoc[]) to the old monolithic file after this branch had already split it into cluster-capacity-limits.adoc, etcd-storage-limits.adoc, and multi-cluster-deployments.adoc under modules/plan/. That single added line is itself a Parameter 4 violation (generic persona snippet include, forbidden by the JTBD checklist), so nothing needed to be ported forward. Resolved by keeping the deletion. Post-rebase fixes found while re-validating: - Removed 2 pre-existing include::partial$snip_persona-admin.adoc[] violations carried over from Install into calculating-che-resource-requirements.adoc and installing-the-chectl-management-tool.adoc (Parameter 4 FAIL) - Fixed 2 broken xrefs in already-merged content that the rebase pulled in, which still pointed at the pre-move paths for files this PR relocates to modules/plan/: - modules/troubleshoot/pages/troubleshooting-workspace-startup-failures.adoc: xref:install:calculating-che-resource-requirements.adoc[] -> xref:plan:calculating-che-resource-requirements.adoc[] - modules/discover/pages/what-is-che.adoc: xref:supported-platforms.adoc[] -> xref:plan:supported-platforms.adoc[] Verified: zero remaining snip_persona includes in modules/plan/, zero remaining bare/legacy xrefs anywhere in the tree pointing at the files this PR moves. Pre-existing Vale errors in troubleshooting-workspace-startup-failures.adoc (lines 44/46/55/69, CheDocs.Attributes) confirmed present on main before this rebase -- out of scope for this fix. Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-plan-category
branch
from
September 17, 2026 07:19
4ccaa34 to
4cd0bdf
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this pull request change?
Plan module (new)
Creates
modules/plan/as a top-level Antora module. Moves planning content from Install and Discover modules. Breaks the monolithicrunning-at-scale.adocinto 3 focused concept pages.6 pages in
modules/plan/pages/:supported-platforms.adoccalculating-che-resource-requirements.adoccluster-capacity-limits.adocetcd-storage-limits.adocmulti-cluster-deployments.adocinstalling-the-chectl-management-tool.adocOptimize module (3 new procedure pages)
Adds 3 procedures to reduce etcd storage pressure on large clusters:
configuring-automatic-cleanup-of-inactive-workspaces.adocdisabling-workspace-ca-bundle-mount.adocdisabling-copied-csvs.adocPlan nav links to these Optimize procedures via cross-module xrefs (pain + solution together in the user journey).
Also moved: 4 examples, 1 image directory.
Updated: install/nav.adoc, discover/nav.adoc, optimize/nav.adoc, antora.yml, 13+ cross-module xrefs.
Backward-compatible URLs:
:page-aliases:added forinstall:,discover:, andadministration-guide:redirects.Zero content loss. Matches downstream devspaces-documentation structure.
Made with Cursor