[
https://issues.apache.org/jira/browse/SOLR-14149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17021547#comment-17021547
]
David Smiley commented on SOLR-14149:
-------------------------------------
See my PR; I didn't put much time into it. changes2html.pl references "Versions
of Major Components" but I'm not sure if it should continue to (if it processes
all releases, not just the latest that don't have it). I didn't run any
scripts; I just made some quick edits for review.
Perhaps controversially, I removed "Upgrade Notes" from CHANGES.txt because
arguably this should only go to solr-upgrade-notes.adoc because it's more
narrative-like and doesn't replace the Jira issue references that generally
should remain in their appropriate sections. WDYT? I predict [~ctargett] is a
fan and I want to make her happy :)
> Remove non-changes from CHANGES.txt
> -----------------------------------
>
> Key: SOLR-14149
> URL: https://issues.apache.org/jira/browse/SOLR-14149
> Project: Solr
> Issue Type: Improvement
> Reporter: David Smiley
> Assignee: David Smiley
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Our CHANGES.txt should just list our changes / release notes. Nothing else.
> * no Introduction
> * no "Getting Started"
> * no "Versions of Major Components" with each release.
> We have a website, a reference guide, and a README.md that are all more
> suitable places. Lets not maintain it here as well; lets keep this file
> focused on it's namesake. We can/should *link* to that information from
> CHANGES.txt. For example linking to
> https://lucene.apache.org/solr/guide/8_4/solr-upgrade-notes.html is highly
> appropriate as it's a more user friendly editorialized version of CHANGES.txt.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
