oxidecomputer / oxidecomputer/cluster-api-provider-oxide
Docs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 1
- Avg merge
- 3h 57m
- Merged PRs (30d)
- 6
Description
The existing docs are mostly auto-generated via kubebuilder. We should drop any generated docs and replace them with a useful description of the repo. We should also add a quickstart to go from an empty rack to a management cluster and workload cluster. We should also ensure that generated docs are correct and complete, checking comments and kubebuilder annotations on at least OxideClusterSpec and OxideMachineSpec.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's current kubebuilder-generated documentation and the comments and annotations on OxideClusterSpec and OxideMachineSpec. Verify what is generated, then outline the repository description and the empty-rack-to-management-and-workload-cluster quickstart; done means the generated docs are removed or corrected and both specs' documentation is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100