quickwit-oss / quickwit-oss/quickwit
Improve doc wording on file backed metastore usage
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
As reported by @imotov, some comments about the file backed metastore usage are outdated.
Example from architecture page:
In a clustered deployment, the metastore is typically a traditional RDBMS like PostgreSQL which we only support today. In a single-server deployment, it’s also possible to rely on a local file or on Amazon S3.
It's outdated as we can have several nodes with only one metastore service and it will work
We should be clearer on the right setup and explain why two metastore writers should be avoided at all costs.
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 architecture page and locate the documentation describing file-backed metastore deployment. Update the wording to explain that several nodes can use one metastore service and why multiple metastore writers should be avoided; done means the deployment guidance is accurate and unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, postgresql
- Domain
- databases, distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100