linkerd / linkerd/linkerd-examples
linker-to-linker yaml documentation
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 444
- Forks
- 216
- PR merge metrics
- No merged PRs in 30d
Description
Could we have more documentation in that config file, so users could read and understand what is being configured in there?
I would love that a user could just read that and understand what is happening and re-work that config file for their own purpose.
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
Locate the linker-to-linker YAML configuration in the repository's examples and read how it is currently structured. Document what each relevant configuration section controls and how a user can adapt it for their own purpose; done means the file can be understood without consulting external context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100