[jira] [Created] (LUCENE-10270) Improve MIGRATE.md

["Robert Muir (Jira)" <ji...@apache.org>]

Robert Muir created LUCENE-10270:
------------------------------------

             Summary: Improve MIGRATE.md
                 Key: LUCENE-10270
                 URL: https://issues.apache.org/jira/browse/LUCENE-10270
             Project: Lucene - Core
          Issue Type: Task
            Reporter: Robert Muir


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)




--
This message was sent by Atlassian Jira
(v8.20.1#820001)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org