quickwit-oss / quickwit-oss/quickwit
Make storage setup more visible in the docs
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
Currently, the storage docs are located in the storage URI configuration and several storage setup guides.
Let's reorganize a bit this part by:
- simplify the storage URI
- create a new directory with all supported storages
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 storage URI configuration documentation and the existing storage setup guides. Review how the supported storages are currently organized, then confirm that the URI section is simpler and the supported-storage guides are grouped in a new directory.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100