Hi, One question: should we also add signatures and checksums on the pdf artifact? In my opinion we should create those so we can verify that we all vote on the same pdf file created by the RM. The GPG signature would ensure this.
Uwe "Hoss Man (Confluence)" <[email protected]> schrieb: >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) > >Change Comment: >--------------------------------------------------------------------- >tweak pre/post publish actions to match how the Upgrade page currently >exists > >Edited by Hoss Man: >--------------------------------------------------------------------- >{toc} > >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 > >* 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 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 >people.apache.org, named appropriately as a release candidate. For >example... >\\ >{noformat}scp solr-220713-2054-17096.pdf >people.apache.org:public_html/apache-solr-ref-guide-4.4_RC1.pdf{noformat} > >{note}The Export URLs returned by the "Download here" link won't work >from curl on people.apache.org, 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 >{{http://people.apache.org/~yourname/apache-solr-ref-guide-X.Y_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 its 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. >The status of the mirrors can be monitored using >{{dev-tools/scripts/poll-mirrors.pl}}... >\\ >{noformat} >perl dev-tools/scripts/poll-mirrors.pl -details -p >lucene/solr/ref-guide/apache-solr-ref-guide-X.Y.pdf >{noformat} > >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.Y.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.Y.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 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|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) >* On the [Upgrading Solr] page: >** Move any major items to the "Upgrading from Older Versions of Solr" >section. >** 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|https://lucene.apache.org/solr/documentation.html] > >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.Y" >https://dist.apache.org/repos/dist/release/lucene/solr/ref-guide/apache-solr-ref-guide.X.Y.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 > > > -- Uwe Schindler H.-H.-Meier-Allee 63, 28213 Bremen http://www.thetaphi.de
