Improve MIGRATE.md around analyzers artifacts. #488
Conversation
Move this to the very top of MIGRATE, the user needs to first be able to pull in the artifacts, before doing anything else like trying to compile, deal with renamed classes, etc. Add a table of each package that got moved, with explicit old and new names. Hopefully it helps search engines and users.
…markdown rendering
|
A separate note: The new name is also more conforming what the modules relay do: They are not only "analyzers", those are compoents for "analysis" of text while indexing/searching lucene. So new name is better. Maybe add this to explanation. |
|
Table looks much better now. Thanks! |
|
Sorry for all the commits, I wanted to try to make this easy to read and prominent, and linked from the README too for more visibility. I realize the
|
|
Originally I made the MIGRATE.md a markdown file to have all formatting possibilities. The unordered list was just a "quick conversion" from the old format introduced in Lucene 4.0. The Markdown converter accepts all markdown in the |
I'd rather not mix in justification/reasoning for any changes in this file, I think it adds noise. Most users will be annoyed with us regardless :) I think this file should just be simple hints of how to fix your code? We list the JIRA issue for each change already, in case an interested party wants to drill down to background discussion of why changes were done, or get any more detailed information. |
|
This was just meant as a replacement for this text: "and are now consistent with repository module 'analysis'". This does not sound like a acceptable explanation to an annoyed user, so my idea was to just say: "better name because it does more than providing analyzers". But all fine, was just my 2ct. |
|
Hi Robert, If you don't mind I will add a change to fix the converter: So please wait a bit with merging! |
* Improve MIGRATE.md around analyzers artifacts. Move this to the very top of MIGRATE, the user needs to first be able to pull in the artifacts, before doing anything else like trying to compile, deal with renamed classes, etc. Add a table of each package that got moved, with explicit old and new names. Hopefully it helps search engines and users. Link to MIGRATE.md explicitly from README.md
* Improve MIGRATE.md around analyzers artifacts. Move this to the very top of MIGRATE, the user needs to first be able to pull in the artifacts, before doing anything else like trying to compile, deal with renamed classes, etc. Add a table of each package that got moved, with explicit old and new names. Hopefully it helps search engines and users. Link to MIGRATE.md explicitly from README.md
Move this to the very top of MIGRATE, the user needs to first be able to pull in the artifacts, before doing anything else like trying to compile, deal with renamed classes, etc.
Add a table of each package that got moved, with explicit old and new names. Hopefully it helps search engines and users.
@jpountz I'd like to backport this to 9.0 if possible, since we are respinning for module names anyway. It is low risk.
Description
Please provide a short description of the changes you're making with this pull request.
Solution
Please provide a short description of the approach taken to implement your solution.
Tests
Please describe the tests you've developed or run to confirm this patch implements the feature or solves the problem.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.