[
https://issues.apache.org/jira/browse/LUCENE-4943?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13636375#comment-13636375
]
Uwe Schindler commented on LUCENE-4943:
---------------------------------------
In my opinion, we should separate the migration/update guide completely from
the changes.txt (also in solr).
>From the "usability" standpoint on the documentation homepage (index.xsl, the
>page generated by ant process-webpages) should have a separate link to this
>guide (like the MIGRATE.txt guide). By this a user gets a nice HTML-formatted
>guide.
And the Markdown parser has more features to make nice HTML than changes2html.
> remove 'Changes to Backwards Compatibility Policy' from lucene/CHANGES.txt
> --------------------------------------------------------------------------
>
> Key: LUCENE-4943
> URL: https://issues.apache.org/jira/browse/LUCENE-4943
> Project: Lucene - Core
> Issue Type: Bug
> Reporter: Robert Muir
> Fix For: 4.4
>
>
> CHANGES.txt is useful to summarize the changes in a release.
> However its expected that a lot of changes will impact the APIs, this
> currently hurts the quality of CHANGES.txt because it leads to a significant
> portion of changes (whether they be bugs, features, whatever) being grouped
> under this one title.
> It also leads to descriptions of CHANGES being unnecessarily verbose.
> I think it makes CHANGES confusing and overwhelming, and it would be better
> to have a simpler 'upgrading' section with practical information on what you
> actually need to do (like Solr's CHANGES.txt).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
