Author: alopresto
Date: Wed Nov 28 05:02:50 2018
New Revision: 1847615
URL: http://svn.apache.org/viewvc?rev=1847615&view=rev
Log:
Added instructions on maintaining existing version component documentation to
Release Guide.
Modified:
nifi/site/trunk/release-guide.html
Modified: nifi/site/trunk/release-guide.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/release-guide.html?rev=1847615&r1=1847614&r2=1847615&view=diff
==============================================================================
--- nifi/site/trunk/release-guide.html (original)
+++ nifi/site/trunk/release-guide.html Wed Nov 28 05:02:50 2018
@@ -545,12 +545,22 @@ the archive location. See current page
page as described delete artifacts other than the current/new release from the
dist/nifi SVN storage. They are already<br>
in the archive location so no need to do anything else.</p></li>
<li><p>Update the <a
href="https://cwiki.apache.org/confluence/display/NIFI/Migration+Guidance";>Migration
Guide</a> on the Wiki.</p></li>
-<li><p>If the release is on the latest development line, update the NiFi
website documentation pages to match the release.</p>
+<li><p>If the release is on the latest development line, update the NiFi
website documentation pages to match the release. <em>(This section will be
updated when a complete plan for maintaining different versions of the guides,
API docs, etc. is available.)</em></p>
<ol>
<li>Run the NiFi ${NIFI_VERSION}</li>
<li>Pull down the documentation by running <code>wget -prk
http://${host}:${port}/nifi-docs/documentation</code></li>
-<li>Rename the file index file that was generated by running <code>mv
${host}:${port}/nifi-docs/documentation
${host}:${port}/nifi-docs/index.html</code></li>
-<li>Use svn to replace the <code>nifi</code> and <code>nifi-docs</code>
folders in <code>https://svn.apache.org/repos/asf/nifi/site/trunk/docs</code>
with those in the <code>${host}:${port}</code> directory pulled down above</li>
+<li>Rename the directory to avoid escaping characters by running <code>mv -v
${host}\:${port} ${NIFI_VERSION}-docs</code></li>
+<li>Rename the file index file that was generated by running <code>mv -v
${NIFI_VERSION}-docs/nifi-docs/documentation
${NIFI_VERSION}-docs/nifi-docs/index.html</code></li>
+<li>Merge the existing documentation (i.e. version <em>n-1</em>, <em>n-2</em>,
etc.) with the new version documentation <em>(<code>rsync</code> is used to
avoid issues with recursion and merging)</em>
+<ol>
+<li>Checkout the existing Subversion repository containing the docs by running
<code>svn co https://svn.apache.org/repos/asf/nifi/site/trunk/docs
svn-docs</code></li>
+<li>Replace the <code>nifi</code> directory (site JS assets, images, etc.) by
running <code>rsync -av ${NIFI_VERSION}-docs/nifi/ svn-docs/nifi/</code></li>
+<li>Replace the <code>nifi-docs/...</code> directories (guides, API docs,
JS/CSS assets, images, etc. but <em>excluding</em> <code>component</code> docs)
by running <code>rsync -av --delete --exclude='components'
${NIFI_VERSION}-docs/nifi-docs/ svn-docs/nifi-docs/</code> (the trailing
slashes are important)</li>
+<li>Merge the component documentation by running <code>rsync -av
${NIFI_VERSION}/nifi-docs/components/ svn-docs/nifi-docs/components/</code></li>
+<li>(Optional) Check the status by running <code>svn st svn-docs</code></li>
+<li>Add the new files to version control by running <code>cd svn-docs
&& svn add . --force</code></li>
+<li>Commit the changes by running <code>svn ci -m "Added ${NIFI_VERSION}
docs to NiFi site."</code></li>
+</ol></li>
</ol></li>
<li><p>In JIRA mark the release version as 'Released' and 'Archived' through
'version' management in the 'administration' console.</p></li>
<li><p>Ensure the release artifacts are successfully mirrored to the archive,
specifically
https://archive.apache.org/dist/nifi/${NIFI_VERSION}/nifi-${NIFI_VERSION}-bin.tar.gz.<br>
