Skip to content

Remove troubleshooting documentation from operator nav - #1683

Merged
aantn merged 7 commits into
masterfrom
claude/fix-nav-config-reference-QOtjv
Mar 6, 2026
Merged

aantn merged 7 commits into
masterfrom
claude/fix-nav-config-reference-QOtjv

Conversation

@aantn

@aantn aantn commented Mar 6, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Removed the "Troubleshooting" page from the operator documentation navigation menu in mkdocs.yml.

Changes

  • Removed the "Troubleshooting": operator/troubleshooting.md navigation entry from the operator section

Notes

This change removes the troubleshooting documentation link from the navigation structure. The actual documentation file may still exist in the repository but will no longer be accessible through the main navigation menu.

https://claude.ai/code/session_01M6qUqTTmhE9kGYkmmaAU3b

Summary by CodeRabbit

  • Documentation
    • Removed the Troubleshooting entry from site navigation.
    • Removed the Operator Architecture document and its navigation links.
    • Removed the CNCF Self Assessment document and excluded it from builds.
    • Excluded the data-sources/permissions page from site builds.
    • Updated the operator overview to a distributed-architecture narrative and added key design decisions.

claude added 2 commits March 6, 2026 06:50
The nav config referenced operator/troubleshooting.md which was never
created, causing a MkDocs build warning. General troubleshooting content
already exists at reference/troubleshooting.md.

https://claude.ai/code/session_01M6qUqTTmhE9kGYkmmaAU3b
Signed-off-by: Claude <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 6, 2026 •

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cad0f4b5-e3cd-44a2-85ce-3a9d640b9ea3

📥 Commits

Reviewing files that changed from the base of the PR and between 5b0d9ef and 73f3e6c.

📒 Files selected for processing (1)
  • mkdocs.yml

Walkthrough

Deleted two large documentation files (ADR and CNCF self‑assessment), updated site navigation/config (mkdocs.yml) to change excluded docs and remove Holmes Operator Troubleshooting/CNCF entries, and edited operator docs (docs/operator/index.md, docs/operator/development.md) with architecture text and a removed link.

Changes

Cohort / File(s) Summary
Site config
mkdocs.yml
Updated navigation and exclude list: added docs/data-sources/permissions.md to exclude_docs; removed Holmes Operator Troubleshooting and CNCF Self Assessment nav entries.
Deleted ADR
docs/adr/operator-initial-architecture.md
Entire ADR file removed (full architecture document deleted).
Deleted self-assessment
docs/cncf-self-assesment.md
Entire CNCF self-assessment document removed.
Operator docs edits
docs/operator/index.md, docs/operator/development.md
index.md replaced link with a distributed operator architecture narrative and added Key Design Decisions; development.md had the Architecture link removed from Next Steps.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title describes removing a Troubleshooting entry from navigation, but the PR also removes two substantial documentation files (operator-initial-architecture.md and cncf-self-assesment.md) and updates the operator index with architectural details. Revise the title to capture the primary changes, such as: 'Consolidate operator documentation and remove redundant navigation entries' or 'Remove duplicate architecture documentation and update operator index'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify

netlify Bot commented Mar 6, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for holmes-docs ready!

Name Link
🔨 Latest commit 73f3e6c
🔍 Latest deploy log https://app.netlify.com/projects/holmes-docs/deploys/69ab078937608b0007fa5728
😎 Deploy Preview https://deploy-preview-1683--holmes-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

claude and others added 4 commits March 6, 2026 07:52
- Add adr/operator-initial-architecture.md to Operator nav section
- Exclude data-sources/permissions.md (redirect-only page) from docs

https://claude.ai/code/session_01M6qUqTTmhE9kGYkmmaAU3b
Signed-off-by: Claude <noreply@anthropic.com>
- Delete adr/operator-initial-architecture.md (redundant with operator/
  docs which are more complete and up to date)
- Delete cncf-self-assesment.md (no longer needed)
- Remove references to deleted files from nav, operator/index.md, and
  operator/development.md

https://claude.ai/code/session_01M6qUqTTmhE9kGYkmmaAU3b
Signed-off-by: Claude <noreply@anthropic.com>
Preserved the still-relevant design decisions from the deleted ADR
(Job/CronJob pattern, distributed architecture, APScheduler choice,
HealthCheck resources as audit trail) in the operator overview page.

https://claude.ai/code/session_01M6qUqTTmhE9kGYkmmaAU3b
Signed-off-by: Claude <noreply@anthropic.com>
@aantn
aantn enabled auto-merge (squash) March 6, 2026 10:12
@aantn
aantn merged commit 06ac630 into master Mar 6, 2026
9 of 14 checks passed
@aantn
aantn deleted the claude/fix-nav-config-reference-QOtjv branch March 6, 2026 16:58
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.

3 participants