Developer Documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 11.5k
- Forks
- 1.4k
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 53
Description
## Feature Request
The Linkerd2-Proxy needs better developer documentation. Empower contributors to be able to work in the productivity fast lane
### What problem are you trying to solve?
Contributing developers should be able to read docs that demonstrate a simple setup in order to easily build, run and debug the proxy inside and outside of a k8s environment.
### How should the problem be solved?
The Linkerd2-Proxy repo needs good developer documentation allowing them to:
- Build
- Run (locally, outside of a k8s environment)
- Debug (provide tooling for building a remote debuggable image)
- Understand the proxy project architecture
- Documentation describing the assembly of the pipeline/layer cake (Layer, Stack, Service)
There should be some canned dev environment / setups documented that allow developers to get up and running in development mode with minimal dependencies.
### Any alternatives you've considered?
### How would users interact with this feature?
By reading and following documentation. :)
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 in the Linkerd2-Proxy repository by locating the existing developer guidance for building, running, debugging, and proxy architecture. Document minimal local and Kubernetes-independent setups, remote-debuggable image tooling, and the Layer/Stack/Service pipeline so a contributor can follow the instructions from setup through debugging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes, rust
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100