actions / actions/actions-runner-controller
Create dedicated implentation docs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 6.5k
- Forks
- 1.5k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 27
Description
Ref https://github.com/actions-runner-controller/actions-runner-controller/discussions/1485
With the new logic we should probably remove the Runner kind from the user docs as the kind no longer supports the ephemeral: true feature really, this is by design and is not a bug. The Runner kind should now be viewed as an implementation detail with end users deploying abstractions (RunnerDeployment and RunnerSet). It would be helpful to create implementation docs which detail the plumbing of how ARC works for those that want to understand the implementation at a greater detail, this should be separate to usage docs (the repo README.md) as the implementation details should not be needed to use the project.
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 with discussion 1485 and the repository README.md to understand the intended distinction between usage and implementation documentation. Review how Runner, RunnerDeployment, and RunnerSet are described, then create separate implementation documentation covering the plumbing at a greater level of detail. Done means usage docs no longer present Runner as an end-user abstraction and the implementation details have a separate home.
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
- 45/100