bottlerocket-os / bottlerocket-os/bottlerocket-test-system
Review Documentation
- Dominant language
- Rust
- Stars
- 18
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
This repo has had a decent amount of refactoring recently, we should go through the documentation we have and make sure all it is still accurate.
- [ ] Guide for using each agent
- [ ] os testing documentation
- [ ] workload testing documentation
- [ ] describe test/resource states
- [ ] controller step of reconciliation
- [ ] debugging guide
- [ ] cli features
Contributor guide
Research direction
Start by reviewing the repository documentation and the recent refactoring, then work through the seven checklist areas: agent guides, OS and workload testing, resource states, reconciliation, debugging, and CLI features. Done means each listed topic is documented accurately and the checklist can be closed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100