Skip to content

docs: restructure operator guide index into navigation hub#1036

Open
zhoward-1 wants to merge 5 commits intomainfrom
docs/operator-guide-index-restructure
Open

docs: restructure operator guide index into navigation hub#1036
zhoward-1 wants to merge 5 commits intomainfrom
docs/operator-guide-index-restructure

Conversation

@zhoward-1
Copy link
Copy Markdown
Contributor

Summary

The current operator-guides/index.md is the full platform configuration reference, not a navigation hub. Operators arriving at the guide have no entry point — they land in a wall of YAML with no context for where to start.

Changes:

  • Rename index.mdplatform-setup.md (content unchanged, just renamed)
  • Create new index.md as a navigation hub with:
    • A getting-started reading path for fresh deployments (platform setup → register cluster → serving → auth)
    • Organized tables linking to every operator guide by category (platform config, jobs, serving, UI, integrations, operations, ingester)

Part of the operator/contributor guide improvements proposed in #1033.

🤖 Generated with Claude Code

zhoward-1 and others added 4 commits April 1, 2026 17:59
Rename index.md → platform-setup.md (content unchanged) and create
a new index.md as a navigation hub with a getting-started reading
path and organized sections linking to all operator guides.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
No native integration exists - update the Integrations table entry
to accurately describe the guide as deployment guidance for running
MLflow alongside Michelangelo.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Surfaces Michelangelo's integration points under a dedicated section
framed around adopter use cases: experiment tracking, model registry,
custom serving backends, custom job schedulers, and compute cluster
registration. Also broadens the intro to reflect the integration goal.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ingester-design.md and ingester-sandbox-validation.md do not exist
in the repo or any open PR, causing Docusaurus build failures.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.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