Repository navigation
docs: update readme features and orchestrators - #1282
Merged
Merged
Conversation
The readme and the docs site introduction were out of date. The features list promised start, stop and pause calls that the API does not have, and said CNI support was coming soon, while networking is done with TAP and macvtap devices. It also left out Cloud Hypervisor, virtiofs, CPU configuration and the guest agent vsock device. Rewrite the features list from the API types and the provider capabilities. List Battery and Brigade next to Cluster API Provider Microvm as projects that orchestrate flintlock. Remove the note about Weaveworks from the top of the readme, the acknowledgements section already covers it. Signed-off-by: Richard Case <richard.case@outlook.com>
✅ Deploy Preview for flintlock-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
These focused documentation changes match the reviewed API and provider capabilities, with no unresolved issues.
Review effort: Balanced
Findings: None
What changed in this PR
Updates the project’s introductory documentation to reflect current microVM capabilities and orchestration options.
Changes:
- Adds Battery and Brigade alongside Cluster API Provider Microvm.
- Replaces outdated feature claims with supported API operations and provider capabilities.
- Removes the README’s opening ownership notice while retaining acknowledgements.
| File | Description |
|---|---|
| userdocs/docs/intro.md | Updates hypervisor support, orchestrators, and features. |
| README.md | Refreshes orchestrators and features; removes the opening ownership notice. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
What
Updates
README.mdanduserdocs/docs/intro.md:Why
The features list was out of date:
MicroVMservice only has create, delete, get and list calls.The docs site introduction also said that Firecracker is supported "initially", with Cloud Hypervisor to come. Both are supported today.
Notes
The docs site was not built locally for this change.