Populate MIGRATE.txt with useful information for upgrade to Lucene 5.0 [LUCENE-5985]
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
We have the migration guide (formatted as markdown) in the Lucene root directory.
Unfortunately, not all breaking changes are explained there (like NIO2 changes or removal of FieldCache). We should collect those breaking issues and give some instructions how to migrate your code to 5.0.
---
Migrated from [LUCENE-5985](https://issues.apache.org/jira/browse/LUCENE-5985) by Uwe Schindler (@uschindler)
Contributor guide
Research direction
Start by reading MIGRATE.txt in the Lucene root and compare its existing Lucene 5.0 guidance with the breaking changes mentioned in the issue, especially NIO2 changes and FieldCache removal. Document the missing breaking changes and provide migration instructions so the guide gives useful upgrade coverage for Lucene 5.0.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100