kubernetes-sigs / kubernetes-sigs/reference-docs
Document subresources for API reference
Open
Nobody has claimed this yet.
kind/feature
lifecycle/frozen
triage/accepted
- Dominant language
- HTML
- Stars
- 130
- Forks
- 135
- Avg merge
- 16h 27m
- Merged PRs (30d)
- 3
Description
When a part of the Kubernetes HTTP API includes a subresource, document the subresources.
Related to https://github.com/kubernetes/website/issues/27745 (about eviction within pods)
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 the Kubernetes HTTP API reference and the subresource named in the related issue: eviction within pods. Determine which API parts expose subresources and document them consistently in the reference; done means the relevant subresources are included and the eviction case is covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, kubernetes
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100