docs: restructure CVF documentation and eliminate duplication - #106
Open
yuva29 wants to merge 1 commit into
Open
docs: restructure CVF documentation and eliminate duplication#106yuva29 wants to merge 1 commit into
yuva29 wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the Cluster Validation Framework (CVF) documentation so the RoCE workload docs live under the CVF section, removes duplicated prerequisite/build guidance, and updates navigation/cross-references to match the new layout.
Changes:
- Update Sphinx TOC to reference
cluster_validation_framework/roce-workloadunder the CVF subtree. - Update installation docs and CVF README cross-links to point at the new RoCE workload documentation location.
- Refactor
docs/cluster_validation_framework/roce-workload.mdto clearly separate “getting/building” vs “using” (manual quick start vs CVF automation), and simplifydocker/roce-workload/README.mdto point to the docs site.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sphinx/_toc.yml.in | Updates TOC entry to match the RoCE workload doc’s new location under the CVF subtree. |
| docs/installation/workload.md | Updates the “RoCE Workload Image” link to the new CVF doc path. |
| docs/cluster_validation_framework/roce-workload.md | Reorganizes RoCE workload documentation (image acquisition/build + usage, manual quick start, CVF automation). |
| docs/cluster_validation_framework/README.md | Fixes heading hierarchy for Sphinx rendering and updates references to the RoCE workload doc. |
| docker/roce-workload/README.md | Removes duplicated deployment/usage content and redirects readers to the central docs page. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| # Cluster Validation and Job Scheduling Framework | ||
|
|
||
| The **Cluster Validation and Job Scheduling Framework** is a Kubernetes-based framework designed to periodically verify the health and readiness of worker nodes present in the cluster through active tests. This framework can also be used for validating a set of newly added worker nodes to the kubernetes cluster before scheduling distributed training,inference workloads on them. | ||
| The **Cluster Validation and Job Scheduling Framework** is a Kubernetes-based framework designed to periodically verify the health and readiness of worker nodes present in the cluster through active tests. This framework can also be used for validating a set of newly added worker nodes to the kubernetes cluster before scheduling distributed training,inference workloads on them. |
Move roce-workload.md into cluster_validation_framework/ to match TOC section. Consolidate prerequisites to CVF README as single source of truth. Establish clear ownership: docs page for usage/deployment, docker README for building. Fix heading hierarchy and cross-references. Co-Authored-By: Claude Opus 4 <noreply@anthropic.com>
yuva29
force-pushed
the
restructure-cvf-docs
branch
from
August 12, 2026 04:44
f5eca70 to
e51914b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
roce-workload.mdintocluster_validation_framework/to match its TOC section🤖 Generated with Claude Code