vaadin / vaadin/observability-kit
Demonstrate Observability Kit via scenario-driven examples
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 7
- Forks
- 5
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 25
Description
Problem
The technical pieces of the Observability Kit are in place, but it's still hard for users to grasp what it is — and, just as importantly, what it isn't. Without that, adoption stalls regardless of how complete the implementation is.
Proposal
Demonstrate the Kit through concrete user scenarios that show it in realistic use rather than describing it in the abstract.
Work through the scenarios one at a time. The first will likely surface lessons about framing, level of detail, and format, so we should complete and review it before committing to the shape of the other two.
Contributor guide
No contributing guide indexed for this repository
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 examining the existing Observability Kit implementation and selecting the first realistic user scenario to demonstrate. Work through that scenario and review its framing, level of detail, and format before defining the remaining examples; done means the first scenario is complete and reviewed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100