kubernetes-sigs / kubernetes-sigs/node-feature-discovery
API documentation
Open
kind/feature
lifecycle/frozen
- Dominant language
- Go
- Stars
- 1.1k
- Forks
- 317
- Avg merge
- 21h 39m
- Merged PRs (30d)
- 5
Description
**What would you like to be added**:
Better documentation of the API(s), preferable by auto-generating with e.g. https://github.com/elastic/crd-ref-docs. We'd need to document `api/nfd` and `api/image-compatibility`.
**Why is this needed**:
Better documentation, always up-to-date (if auto-generated)
Contributor guide
Research direction
Review the API definitions under api/nfd and api/image-compatibility, then evaluate the proposed crd-ref-docs generator against them. Done means both APIs have generated, usable documentation that can be kept up to date.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100