Add optimizer documentation and README updates #3518
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
This PR adds documentation for the MCP optimizer feature. Changes include: - Update cmd/vmcp/README.md with optimizer CLI options - Add pkg/vmcp/optimizer/README.md with optimizer architecture docs - Add pkg/vmcp/optimizer/REFACTORING.md with design notes - Update docs/operator/crd-api.md with optimizer CRD fields - Update deploy/charts/operator-crds/README.md This is part 3 of a 3-part PR split. Depends on PR1 (optimizer packages) and PR2 (integration).
therealnb
requested review from
ChrisJBurns,
JAORMX,
amirejaz,
jerm-dro,
jhrozek and
yrobla
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3518 +/- ##
==========================================
+ Coverage 65.29% 65.30% +0.01%
==========================================
Files 401 401
Lines 39103 39103
==========================================
+ Hits 25534 25538 +4
+ Misses 11589 11583 -6
- Partials 1980 1982 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
This PR adds documentation for the MCP optimizer feature.
This is part 3 of a 3-part PR split from #3440:
Depends on: #3516 (PR 1) and #3517 (PR 2)
Changes
Documentation
cmd/vmcp/README.mdwith optimizer CLI optionspkg/vmcp/optimizer/README.mdwith optimizer architecture docspkg/vmcp/optimizer/REFACTORING.mdwith design notesdocs/operator/crd-api.mdwith optimizer CRD fieldsdeploy/charts/operator-crds/README.mdTest Plan