quickwit-oss / quickwit-oss/quickwit
Create a nicer set of demos of Quickwit
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
Currently, most people probably don't know we have a basic demo: https://common-crawl.quickwit.io/
It would be nice to have the following:
- Better documentation to the demo and how it works i.e. walking you through the steps it's doing internally.
- Maybe something like aggregations demoing?
- Maybe more than one demo on some other datasets, i.e. traces.
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 with the existing demo at https://common-crawl.quickwit.io/ and inspect how its internal steps are presented. Define the scope for documenting that workflow and adding aggregation or additional-dataset demos, then verify that the selected demos are accessible and their behavior is explained.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100