Agree, Erick. The new guide is amazing!

Steve, could we perhaps have a change-history.adoc as part of the refguide 
itself, so every (major) change to the guide would add a line on that page? 
Benefit is that it would follow the guide, whether in HTML or PDF format.

Another option is to just keep it lightweight and do some kind of GIT magic as 
part of refGuide release process to select all commits since last release that 
include adoc changes, and then pull the commit messages from those and generate 
a release-notes file. We could also include in that file a git diff that could 
be used as an aid for people when reviewing/voting for a ref-guide release, 
i.e. one place to double check that no weird edits have sneaked in since last 
release…

--
Jan Høydahl, search solution architect
Cominvent AS - www.cominvent.com

> 30. mai 2017 kl. 20.37 skrev Steve Rowe <sar...@gmail.com>:
> 
> 
>> On May 30, 2017, at 2:04 PM, Erick Erickson <erickerick...@gmail.com> wrote:
>> 
>> 4> I don't think minor edits require a JIRA, larger ones maybe. Pretty
>> much just like the CWiki I suppose.
> 
> One more thing I ran into while making the changes on SOLR-10758:
> 
> 5> I included a new "Ref Guide” section under the 6.6 release in 
> solr/CHANGES.txt, but this was premature, since: a) the ref guide release is 
> still separate from the code release, so solr/CHANGES.txt isn’t the right 
> place (yet); and b) even after we make the ref guide release part of the code 
> release, it’s not clear that ref guide change notes belong in 
> solr/CHANGES.txt, since e.g. javadocs-only changes never get mentioned there. 
>  (Personally I think there should eventually be some form of CHANGES-like 
> release notes for the ref guide.)
> 
> (I haven’t reverted my “Ref Guide” section addition to solr/CHANGES.txt 
> because there is a 6.6 RC vote underway, and if it succeeds reversion will be 
> pointless.)
> 
> --
> Steve
> www.lucidworks.com
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
> For additional commands, e-mail: dev-h...@lucene.apache.org
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org

Reply via email to