quickwit-oss / quickwit-oss/quickwit
Aggregation documentation is twisted
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
Our aggregation doc is inspired from elastic. Of course, the API itself is aiming at elasticsearch compatible.
The trouble is that the documentation of elasticsearch on this specific topic is terribly twisted.
Presenting metric and bucket aggregation as two different aggregations is really twisted.
Those two are fundamentally an XY axis.
Metrics is the stuff we measures and buckets is way we build groups on which to measure a metric.
When one can defines a group aggregation, the API makes it seem there are no metrics, but there is an implicit count metrics.
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 reading the current aggregation documentation and compare its presentation with Elasticsearch's model. Rework the explanation so metrics are described as measurements, buckets as groups, and grouped aggregations make the implicit count metric clear; done when the documentation presents these relationships without the current ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100