Skip to content

docs(guides): reorganize observability documentation#1130

Merged
zhoujh01 merged 1 commit intomainfrom
docs/observability-guides
Mar 31, 2026
Merged

docs(guides): reorganize observability documentation#1130
zhoujh01 merged 1 commit intomainfrom
docs/observability-guides

Conversation

@qin-ctx
Copy link
Copy Markdown
Collaborator

@qin-ctx qin-ctx commented Mar 31, 2026

Description

Reorganize the observability guides so operational entry points are grouped under a dedicated observability page, while operation telemetry remains a focused reference.

Related Issue

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Replace the old monitoring guides with new 05-observability.md guides in both Chinese and English.
  • Move ov tui and OpenViking Console guidance into the observability guides and keep 07-operation-telemetry.md focused on telemetry reference content.
  • Update deployment and cross-guide links to point to the renamed observability guides.

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Docs-only change; no automated tests were run.

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

Additional Notes

  • 05-monitoring.md is replaced by 05-observability.md in both language trees.
  • 07-operation-telemetry.md remains as the detailed telemetry reference page.

Promote observability to a dedicated guide and keep telemetry as a focused reference.
@github-actions
Copy link
Copy Markdown

Failed to generate code suggestions for PR

@zhoujh01 zhoujh01 merged commit 355130a into main Mar 31, 2026
2 checks passed
@zhoujh01 zhoujh01 deleted the docs/observability-guides branch March 31, 2026 12:24
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenViking project Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants