quickwit-oss / quickwit-oss/quickwit
Add pulsar internal docs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
There are some subtleties on pulsar inner workings that are not easy to find in the documentation. We should write a short internal docs to not forget it.
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 existing documentation and the Pulsar implementation or entry points. Identify the internal behaviors and subtleties that are missing from the docs, then add a short internal document covering them. Done means the relevant Pulsar knowledge is recorded where project contributors can find it.
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
- Needs clarification
- Newbie friendliness
- 35/100