actions / actions/actions-runner-controller
add additional `RunnerSet` examples and generate HTML apidocs for CRDs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 6.5k
- Forks
- 1.5k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 27
Description
Is your feature request related to a problem? Please describe.
RunnerSet examples are incomplete and there appears to be no apidoc specs for the RunnerSet CRD (or any other CRD)
Describe the solution you'd like
A more elaborate RunnerSet example, including examples of persistent storage, in addition, HTML docs for CRD specs would be helpful.
Describe alternatives you've considered
After some brute force, I figured it out, but it'd be nice if there were concrete examples or more comprehensive api docs.
Additional context
n/a
Contributor guide
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 locating the existing RunnerSet examples and the RunnerSet CRD definitions in the repository, then inspect how current project documentation is organized or generated. Done means adding a persistent-storage RunnerSet example and providing HTML API documentation for the CRD specs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100