quickwit-oss / quickwit-oss/quickwit
[Documentation] Doc mapping field types
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
The documentation is unclear raw types vs composite types.
raw type also contains json type, which can be considered a composite type.
It's unclear when to pick json or object
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 linked index configuration documentation and compare its explanations of raw types, composite types, json, and object. Clarify whether json belongs under raw or composite types and explain when users should choose json versus object; the documentation should make those choices unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100