Skip to content

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

Open
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-plan-category
Open

chore: Plan as top-level Antora module (JTBD)#3162
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-plan-category

Conversation

@gtrivedi88

@gtrivedi88 gtrivedi88 commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

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 monolithic running-at-scale.adoc into 3 focused concept pages.

6 pages in modules/plan/pages/:

Page Type Source
supported-platforms.adoc Concept Moved from discover/
calculating-che-resource-requirements.adoc Reference Moved from install/
cluster-capacity-limits.adoc Concept New (split from running-at-scale)
etcd-storage-limits.adoc Concept New (split from running-at-scale)
multi-cluster-deployments.adoc Concept New (split from running-at-scale)
installing-the-chectl-management-tool.adoc Procedure Moved from install/

Optimize module (3 new procedure pages)

Adds 3 procedures to reduce etcd storage pressure on large clusters:

Page Purpose
configuring-automatic-cleanup-of-inactive-workspaces.adoc Configure the DevWorkspace Operator pruner
disabling-workspace-ca-bundle-mount.adoc Disable ca-certs-merged ConfigMaps
disabling-copied-csvs.adoc Disable OLM Copied CSVs

Plan 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 for install:, discover:, and administration-guide: redirects.

Zero content loss. Matches downstream devspaces-documentation structure.

Made with Cursor

@gtrivedi88
gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 14, 2026 12:38
@gtrivedi88
gtrivedi88 requested a review from ibuziuk July 14, 2026 12:38
@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown

🎊 Navigate the preview: https://6a67b77a7acdb3ec586091eb--eclipse-che-docs-pr.netlify.app 🎊

@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@gtrivedi88 gtrivedi88 changed the title chore: re-create Plan as top-level Antora module (JTBD) chore: Plan as top-level Antora module (JTBD) Jul 14, 2026
@gtrivedi88
gtrivedi88 force-pushed the jtbd-plan-category branch 3 times, most recently from cbf98bf to 44cf014 Compare July 16, 2026 01:38
@gtrivedi88
gtrivedi88 force-pushed the jtbd-plan-category branch 2 times, most recently from 31e52f5 to 7e404a6 Compare July 27, 2026 19:06
@gtrivedi88
gtrivedi88 force-pushed the jtbd-plan-category branch 5 times, most recently from 09efde7 to dc3c03a Compare July 27, 2026 19:43
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
gtrivedi88 force-pushed the jtbd-plan-category branch from dc3c03a to e2958f0 Compare July 27, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant