Refine documentation and publish client image for releases - #8
Merged
Conversation
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.
This pull request updates the documentation and CI workflow to reflect the NetOpsBench v0.2.0 release, which introduces major new benchmark profiles (Xlarge CLOS and Fat-tree), a native Rust client agent, and improvements to large-topology operation, scoring, and results publication. The documentation is reorganized to highlight the new release, clarify methodology, and separate legacy results. The CI workflow is streamlined to only trigger on tags, and Docker image tagging is updated for consistency.
Major v0.2.0 release and documentation updates:
Release notes and documentation structure:
docs/content/docs/releases/v0.2.0.mdx,docs/content/docs/releases/meta.json,docs/content/docs/meta.json,docs/content/docs/index.mdx, [1] [2] [3] [4].docs/content/docs/index.mdx,docs/content/docs/quickstart.mdx, [1] [2] [3].Benchmark methodology and results presentation:
docs/content/docs/run-benchmarks/methodology.mdx,README.md, [1] [2] [3] [4].docs/content/docs/run-benchmarks/legacy-results.mdx,docs/content/docs/run-benchmarks/meta.json, [1] [2].Operational guidance and cleanup improvements:
docs/content/docs/debug-operate/observability.mdx, [1] [2].CI/CD workflow simplification:
client-agent-imageworkflow is now triggered only on version tags, not on every push to main or file changes, reducing unnecessary builds (.github/workflows/client-agent-image.yml, .github/workflows/client-agent-image.ymlL5-L13).latestare applied when building on a tag (.github/workflows/client-agent-image.yml, .github/workflows/client-agent-image.ymlL41-R35).Other documentation improvements:
README.mdare updated to highlight the v0.2.0 release, new profiles, and dataset publication (README.md, [1] [2] [3].These changes ensure that the documentation, workflow, and public benchmark results are aligned with the new large-scale capabilities and agent lifecycle in NetOpsBench v0.2.0.