quickwit-oss / quickwit-oss/quickwit
Add a documentation section for breaking changes and migration steps
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
We should have a section of documentation were we could capture changes like this one to be documented. We could also add comments like "If you are upgrading from vX.X or bellow, you need to reindex all data" and other suggestions, or necessary steps that users need to perform before or after upgrading.
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 reviewing the linked pull request 3168 diff to understand the breaking change that prompted this request. Then locate the project's documentation structure and define where upgrade notes belong. Done means adding a section that captures breaking changes, migration steps, and guidance such as when reindexing is required.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100