[CONF] Apache Solr Reference Guide > Internal - How To Publish This Documentation

["Hoss Man (Confluence)" <co...@apache.org>]

Space: Apache Solr Reference Guide (https://cwiki.apache.org/confluence/display/solr)
Page: Internal - How To Publish This Documentation (https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation)

Added by Hoss Man:
---------------------------------------------------------------------
{toc}

h1. How To Export the PDF from Confluence

* Load [The PDF Space Export Page|https://cwiki.apache.org/confluence/spaces/flyingpdf/flyingpdf.action?key=solr] in your browser
* Uncheck the box next to [** Internal MetaDocs] to suppress it and it's children from being included in the PDF
* Click the "Export" button
* On the subsequent page, wait for a "Download here" link to dynamically appear.
* Copy the link to your clipboard (it will be something similar to {{https://cwiki.apache.org/confluence/download/temp/pdfexport-20130712-120713-0043-9755/solr-120713-0043-9756.pdf}})
* ssh to people.apache.org and use curl copy the PDF into your public_html directory and name it appropriately as an release candidate.  For example...{noformat}curl -sS --output ~/public_html/apache-solr-ref-guide-4.4_RC1.pdf https://cwiki.apache.org/confluence/download/temp/pdfexport-20130712-120713-0043-9755/solr-120713-0043-9756.pdf{noformat}

h1. Hold a VOTE

* Send an email to dev@lucene (CC general@lucene) with a Subject "VOTE: RC1 Release apache-solr-ref-guide-X.X.pdf" and include the full URL from http://people.apache.org/~yourname/apache-solr-ref-guide-X.X_RC1.pdf"
* If there are problems with the RC that are fixed in Confluence, Export a new copy (using the instructions above) with a new name (RC2, RC3, etc...) and send out another VOTE thread.

h1. Publish to SvnSubPub & Mirrors

Once [three PMC members have voted for a release, it may be published|http://www.apache.org/foundation/voting.html#ReleaseVotes]...

* Check-out the {{lucene/solr/ref-guide}} directory from the dist repo (or svn update if you already have a checkout) ...{noformat}
svn co https://dist.apache.org/repos/dist/release/lucene/solr/ref-guide solr-ref-guide-dist
# OR
svn update solr-ref-guide-dist
{noformat}
* Copy the RC ref guide into this directory using it's final name and commit...{noformat}
cp apache-solr-ref-guide-4.4_RC1.pdf solr-ref-guide-dist/apache-solr-ref-guide-4.4.pdf
svn commit -m "4.4 ref guide" solr-ref-guide-dist
{noformat}
* Wait 24 hours to give the mirrors a chance to get the new release.
(!) :TODO: can we get poll-mirrors.pl setup so it's useful here? (see  LUCENE-5104)

h1. Post Publish Actions

Once most mirrors have been updated, we can link to (and announce) the new guide.

h2. Update Links & Version Numbers

When linking to the "current" version of the ref guide, always use the download redirector. Example:
{{https://www.apache.org/dyn/closer.cgi/lucene/solr/ref-guide/apache-solr-ref-guide.X.X.pdf}}

When linking to "old" versions of the ref guide, always use archive.apache.org.  Example: {{https://archive.apache.org/dist/lucene/solr/ref-guide/apache-solr-ref-guide.X.X.pdf}}

h3. Website (lucene.apache.org)

* Update links on [the Solr documentation page|https://lucene.apache.org/solr/documentation.html] to point to the current version of the ref guide.
* (!) :TODO: Other places to link from? (!)

h3. Confluence

* On the [Confluence Theme Configuration Page|https://cwiki.apache.org/confluence/spaces/doctheme/configuretheme.action?key=solr] for the Solr Ref Guide...
** Update the Left Nav to add a link to the current version of the ref guide.
** Update the Left Nav to change the link for the previous version(s) of the ref guide so that they use the archive URL.
** Update the Header "Message" to refer to the "next" version that the live copy of the documentation will refer to (ie: if the 4.4 ref guide has just been published change "_This Guide Covers The Unreleased Apache Solr v*4.4*_" to "_This Guide Covers The Unreleased Apache Solr v*4.5*_"
* On the [Confluence PDF Layout Page|https://cwiki.apache.org/confluence/spaces/flyingpdf/viewpdflayoutconfig.action?key=solr] for the Solr Ref Guide...
** Update the "Title Page" to refer to the "next" version (ie: 4.4 -> 4.5)
** Update the "Footer" to refer to the "next" version (ie: 4.4 -> 4.5)

h3. Community Wiki

(!) :TODO: what links on MoinMoin will need updated? Any? (!)

h2. Announce

Announce the new Guide on solr-user@lucene, CCing general@lucene and announce@apache.

(If the Ref Guide is being released at nearly the same time as the code, it may make sense to just mention the new guide in the main release announcement)

h2. Remove Archived Versions From the Mirrors

Shortly after new releases are first mirrored, they are copied to archive.apache.org.  Only the latest point release from each active branch should be kept under the Lucene PMC svnpubsub area dist/releases/lucene/. Older releases can be safely deleted since these releases are already backed up in the archives.  Example...

{noformat}
svn rm -m "remove archived ref guide X.X" https://dist.apache.org/repos/dist/release/lucene/solr/ref-guide/apache-solr-ref-guide.X.X.pdf
{noformat}




Stop watching space: https://cwiki.apache.org/confluence/users/removespacenotification.action?spaceKey=solr
Change email notification preferences: https://cwiki.apache.org/confluence/users/editmyemailsettings.action