Skip to content

Docs: Add standard doc comments to well known annotations #3261

Description

@DerekFrank

Description

What problem are you trying to solve?

https://github.com/kubernetes-sigs/karpenter/blob/main/pkg/apis/v1/labels.go#L49

None of those have comments explaining what they do. They probably should, and they should be standard enough for providers to doc-gen them into a reference page like https://kubernetes.io/docs/reference/labels-annotations-taints/

How important is this feature to you?

Nice to have :)

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
  • Comments asking for updates generate extra noise for issue followers and do not help maintainers prioritize issues. If you think the issue is higher priority than it is labelled, please instead add your user story.
  • If you are interested in working on this issue or have submitted a pull request, please assign yourself

Metadata

Metadata

Assignees

Labels

help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.needs-prioritytriage/acceptedIndicates an issue or PR is ready to be actively worked on.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions