Skip to content

docs: promote observability to a top-level section - #64

Merged
artemkovalyov merged 2 commits into
mainfrom
fix/storage-sidebar-overview
Oct 2, 2026
Merged

artemkovalyov merged 2 commits into
mainfrom
fix/storage-sidebar-overview

Conversation

@artemkovalyov

Copy link
Copy Markdown
Contributor

Summary

  • Moves observability docs (Prometheus, Perses, Prysm) out of storage/ into a dedicated top-level observability/ section — the stack covers the whole platform, not just storage
  • Adds Observability to the Documentation nav between Networking and Management
  • Introduces observabilitySidebar() matching the Storage sidebar pattern: non-link section header with Overview as the first linked entry
  • Adds Storage Overview as a highlighted sidebar entry using the same storageSidebar() non-link header pattern
  • Updates all cross-links in architecture.md, full-deployment.md, greenhouse.md, storage/index.md, and overview/index.md

Test plan

  • Navigate to /observability/ — sidebar shows "Observability" as non-link header with "Overview" highlighted
  • Navigate to /storage/ — sidebar shows "Storage" as non-link header with "Overview" highlighted
  • "Observability" appears in the Documentation dropdown nav
  • Cross-links from architecture, getting-started, and management pages resolve correctly
  • Old /storage/observability/ URLs redirect or are no longer referenced

Signed-off-by: Artem Kovalov artem.kovalyov@gmail.com

Move observability docs out of storage/ into a dedicated top-level
section, reflecting that Prometheus, Perses, and Prysm cover the
whole platform rather than storage alone.

- Add Observability to the Documentation nav
- Introduce observabilitySidebar() matching the Storage pattern:
  non-link section header with Overview as the first linked entry
- Update cross-links in architecture, getting-started, management,
  and storage overview pages
- Add Storage Overview as a highlighted sidebar entry using
  storageSidebar() with the same non-link header pattern

Signed-off-by: Artem Kovalov <artem.kovalyov@gmail.com>
Update relative ../ceph link to absolute /storage/ceph now that
prysm.md lives under observability/ rather than storage/observability/.

Signed-off-by: Artem Kovalov <artem.kovalyov@gmail.com>

@s0nea s0nea left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perses and Prometheus parts were moved and not changed as part of the PR.

@berendt berendt left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@senolcolak senolcolak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to proceed.

@artemkovalyov
artemkovalyov merged commit a14ecda into main Oct 2, 2026
5 checks passed
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.

4 participants