[LUCENE-10270] Improve MIGRATE.md

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.1
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Robert Muir
• Created: 30/Nov/21 01:18
• Updated: 28/Aug/22 16:31
• Resolved: 01/Dec/21 10:31

Description

When looking at MIGRATE.md, there are some easy improvements we can make for readability, searchability, presentation.

Here's what I tried to tackle as an initial stab:
1. Separate sections for 9.0 and 9.1
2. Remove abbreviations for artifact, package, class names etc. e.g. `lucene-core` instead of `core` and `org.apache.lucene.analysis` instead of `o.a.l.a`.
3. Specify "java" for text blocks to get syntax highlighting
4. When provided, consistently put JIRA issue in the same place
5. fixed-width font for classes/reserved words (e.g. false, true, long, makes for less ambiguous reading)
6. More use of tables vs lists when there is mapping of old -> new names (packages, classes, etc)
7. Use consistent notation for method calls (Class.method() vs Class.method vs Class#method etc)

Issue Links

• links to: GitHub Pull Request #491