Include details of the Heartbeat component within Architecture docs
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 60
- Forks
- 221
- Avg merge
- 4h 32m
- Merged PRs (30d)
- 1
Description
## Feature Request
### What problem are you trying to solve?
Improve transparency and clarity surrounding the `Heartbeat` cronjob component of the Linkerd control plane.
### How should the problem be solved?
Add a section to the Architecture reference doc explaining the purpose of the `Heartbeat` cronjob.
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 locating the Architecture reference documentation in the Linkerd website and reviewing its existing component sections. Add a section explaining the purpose of the Heartbeat cronjob in the Linkerd control plane, then verify the documentation build or preview renders the new section correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100