Create a glossary of labels/annotations
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 60
- Forks
- 221
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 1
Description
Linkerd uses a variety of labels and annotations on the Kubernetes resources that it creates. We should add a docs page which lists these labels and annotations and explains their meaning and how they are used.
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 reviewing the existing Linkerd documentation and the Kubernetes resources that Linkerd creates to identify the labels and annotations covered by this issue. Create a documentation page that lists each item, explains its meaning, and describes how it is used; done means the glossary is complete and linked from the appropriate documentation area.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100