Skip to content

chore: promote Observe to top-level Antora module (JTBD Phase 3)#3152

Open
gtrivedi88 wants to merge 3 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-observe-category
Open

chore: promote Observe to top-level Antora module (JTBD Phase 3)#3152
gtrivedi88 wants to merge 3 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-observe-category

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

What does this pull request change?

Creates a new top-level modules/observe/ Antora module by extracting all observability content from administration-guide.

7 pages, 10 partials, 19 examples (including 16 telemetry code files), 10 images moved.

Nav structure (user journey order)

  1. What you can observe about Che (overview with data flow architecture)
  2. Monitor Che server (metrics, Prometheus verification, dashboards)
  3. Monitor the DevWorkspace Operator (metrics, Prometheus, dashboards)
  4. How server logging works (log levels, HTTP traffic)
  5. Collect logs with chectl
  6. Configure the Woopra telemetry plugin
  7. Build a custom telemetry plugin

JTBD title rework (all 7 pages + 10 partials)

  • Configuring observability -> What you can observe about Che
  • The Woopra telemetry plugin -> Configure the Woopra telemetry plugin
  • Creating a telemetry plugin -> Build a custom telemetry plugin
  • Configuring server logging -> How server logging works
  • Collecting logs using chectl -> Collect logs with chectl
  • Monitoring the DevWorkspace Operator -> Monitor the DevWorkspace Operator
  • Monitoring Che Server -> Monitor Che server
  • All 10 partial titles reworked from gerund to JTBD
  • All navtitles synced

Cross-module xref updates

  • 6 xrefs to admin-guide pages updated with administration-guide: prefix
  • Admin-guide nav: observability section removed

Added :page-aliases: administration-guide:<page> for all 7 moved pages.

Pull Request checklist

  • No procedure changes — moves and title rework only
  • All pages contain :page-aliases: for backward-compatible URLs
  • Zero content loss

Made with Cursor

Create modules/observe/ with 7 pages, 10 partials, 19 examples,
and 10 images moved from administration-guide.

Nav structure (user journey order):
- What you can observe (overview with data flow architecture)
- Monitor Che server (metrics + dashboard)
- Monitor DevWorkspace Operator (metrics + dashboard)
- How server logging works (log levels, HTTP traffic)
- Collect logs with chectl
- Configure the Woopra telemetry plugin
- Build a custom telemetry plugin

JTBD title rework on all 7 pages + 10 partials.
All navtitles synced. page-aliases added for all 7 pages.
Cross-module xrefs updated (administration-guide: prefix added).

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 6, 2026 04:22
@gtrivedi88 gtrivedi88 requested a review from azatsarynnyy July 6, 2026 04:22
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

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

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-observe-category branch from 546631d to 11b2802 Compare July 6, 2026 05:00
The Discover module's roles-and-tasks page referenced
configuring-observability.adoc at the old admin-guide path.
Updated to observe: cross-module xref.

Co-authored-by: Cursor <cursoragent@cursor.com>
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