lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (Confluence)" <>
Subject [CONF] Apache Solr Reference Guide > Internal - How To Publish This Documentation
Date Mon, 29 Jul 2013 05:49:00 GMT
Space: Apache Solr Reference Guide (
Page: Internal - How To Publish This Documentation (

Change Comment:
overlooked this tidbit about the announce@apache list

Edited by Hoss Man:

h1. Pre-publication Actions

* Make sure that the [Upgrading Solr] page is up to date for the current version.
* Sanity check that none of the [post-publishing version number updating steps|#Update Links
& Version Numbers] from the last version published were skipped.

h1. How To Export the PDF from Confluence

(!) This process needs updated to account for PGP and SHA1 files, hopefully via scripting
-- see [SOLR-5085|]

* Load [The PDF Space Export Page|]
in your browser
* Uncheck the box next to [** Internal MetaDocs] to suppress it and its children from being
included in the PDF
* Click the "Export" button
* On the subsequent page, wait for a "Download here" link to dynamically appear.
* Click "Download here" and save the PDF to your local machine
* Use scp to copy the into your public_html directory on, named appropriately
as a release candidate.  For example...
{noformat}scp solr-220713-2054-17096.pdf{noformat}

{note}The Export URLs returned by the "Download here" link won't work from curl on,
so you have to make a local copy first.{note}

h1. Hold a VOTE

* Send an email to dev@lucene (CC general@lucene) with a Subject "VOTE: RC1 Release apache-solr-ref-guide-X.Y.pdf"
and include the full URL from {{}}.
* 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|]...

(!) This process needs updated to account for PGP and SHA1 files, hopefully via scripting
-- see [SOLR-5085|]

* Check-out the {{lucene/solr/ref-guide}} directory from the dist repo (or svn update if you
already have a checkout) ...
svn co solr-ref-guide-dist
# OR
svn update solr-ref-guide-dist
* Copy the RC ref guide into this directory using its final name and commit...
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
* Wait 24 hours to give the mirrors a chance to get the new release.  The status of the mirrors
can be monitored using {{dev-tools/scripts/}}...
perl dev-tools/scripts/ -details -p lucene/solr/ref-guide/apache-solr-ref-guide-X.Y.pdf

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: {{}}

When linking to "old" versions of the ref guide, always use  Example:

h3. Website (

* Check if any links on the website need updated
** For now (as of July 28, 2013) there is no direct link to any specific version(s) of the
ref guide from the website -- for simplicity the [doc page|]
only has a general link to the mirror network for the [ref-guide directory|]
* (!) Special 4.5 release action item:
** Once multiple versions of the ref guide exists, add verbage to the [doc page|]
along the lines of:{noformat}
Archives for all past versions of the Solr Reference Guide are available at 
[the Apache archives](

h3. Confluence

* On the [Confluence Theme Configuration Page|]
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 Left Nav and 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
"_*4.4* Draft Ref Guide Topics_" to "_*4.5* Draft Ref Guide Topics_" and "_This Unreleased
Guide Will Cover Apache Solr *4.4*_" to "_This Unreleased Guide Will Cover Apache Solr *4.5*_")
* On the [Confluence PDF Layout Page|]
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)
* On the [Upgrading Solr] page:
** Rename the the first "Upgrading from 4.Y.x" section to mach the version just pulished (ie:
if 4.4 was just published name it "Upgrading from 4.4.x")
** Summarize any extremely important items and move them down to the "Upgrading from Older
Versions of Solr" section.
** Empty out the "Upgrading from 4.Y.x" in preparation for new information to be added

h3. Community Wiki

(!) :TODO: what links on MoinMoin will need updated? Any? ... there might be lots of links
to individual dynamic pages from MoinMoin as we start migrating content, but as far as the
released versions go that should probably all be funneled through [the main doc page|]

h2. Announce

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

{note}You must send the announcement email from your address or announce@apache
will automatically reject it{note}

(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  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...

svn rm -m "remove archived ref guide X.Y"

Stop watching space:
Change email notification preferences:


View raw message