[jira] [Commented] (SOLR-5030) determine & document specific steps to "publish" ref guide with each release

["Hoss Man (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-5030?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13706568#comment-13706568 ] 

Hoss Man commented on SOLR-5030:
--------------------------------

I've drafted an initial version of this documenting as best i can forsee how this should work...

https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation

..some of the details may change once we actually go through the process for 4.4, but i'd appreciate it if folks could look it over in advance and speak up early if you see anything that concerns you.

a few things i'd like to draw attention to...

1) this assumes we'll want to keep the ref-guide(s) in a new dist dir: dist/lucene/solr/ref-guide, ala...

* https://www.apache.org/dyn/closer.cgi/lucene/solr/ref-guide/apache-solr-ref-guide.X.X.pdf
* https://archive.apache.org/dist/lucene/solr/ref-guide/apache-solr-ref-guide.X.X.pdf

...this seems like it will be the best approach since we won't be doing "bug fix" releases (ie: 4.4.1) for the ref guide, so it does't make much sense to put them in the existing dist/lucene/solr/X.Y.0 directories -- i don't want someone seeing a download link for dist/lucene/solr/4.4.0/apache-solr-ref-guide.4.4.pdf and thinking it doesn't apply to them since they are using 4.4.3

2) I'm making some suppositions about where we'll want to start linking to the "official" versions of this guide once it is in fact official, but none of those links to be updated on release actually exist yet (because there is no current version) ... if you can think of other places that we should update with link, please comment.


                
> determine & document specific steps to "publish" ref guide with each release
> ----------------------------------------------------------------------------
>
>                 Key: SOLR-5030
>                 URL: https://issues.apache.org/jira/browse/SOLR-5030
>             Project: Solr
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Hoss Man
>            Assignee: Hoss Man
>
> need to document the "release process" for the documentation...
> * how is the PDF generated (SOLR-4886
> * when should things happen (ie: wait until code release vote is final for last minute doc fixes?)
> * call a vote on the PDF
> * where should PDF live once vote is done?
> * where to link to released PDF(s) from site, moinmoin, confluence nav
> * what content needs changed after being published (ie: 4.3 -> 4.4)

--
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: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org