Added instructions on maintaining existing versions of component documentation to...
authorAndy LoPresto <alopresto@apache.org>
Wed, 28 Nov 2018 05:00:03 +0000 (21:00 -0800)
committerAndy LoPresto <alopresto@apache.org>
Wed, 28 Nov 2018 05:00:03 +0000 (21:00 -0800)
src/pages/markdown/release-guide.md

index acef254..46ef9ba 100644 (file)
@@ -468,11 +468,19 @@ in the archive location so no need to do anything else.
 
 1. Update the [Migration Guide][nifi-migration-guide] on the Wiki.
 
-1. If the release is on the latest development line, update the NiFi website documentation pages to match the release.
+1. If the release is on the latest development line, update the NiFi website documentation pages to match the release. _(This section will be updated when a complete plan for maintaining different versions of the guides, API docs, etc. is available.)_
     1. Run the NiFi ${NIFI_VERSION}
     1. Pull down the documentation by running `wget -prk http://${host}:${port}/nifi-docs/documentation`
-    1. Rename the file index file that was generated by running `mv ${host}:${port}/nifi-docs/documentation ${host}:${port}/nifi-docs/index.html`
-    1. Use svn to replace the `nifi` and `nifi-docs` folders in `https://svn.apache.org/repos/asf/nifi/site/trunk/docs` with those in the `${host}:${port}` directory pulled down above
+    1. Rename the directory to avoid escaping characters by running `mv -v ${host}\:${port} ${NIFI_VERSION}-docs` 
+    1. Rename the file index file that was generated by running `mv -v ${NIFI_VERSION}-docs/nifi-docs/documentation ${NIFI_VERSION}-docs/nifi-docs/index.html`
+    1. Merge the existing documentation (i.e. version _n-1_, _n-2_, etc.) with the new version documentation _(`rsync` is used to avoid issues with recursion and merging)_
+        1. Checkout the existing Subversion repository containing the docs by running `svn co https://svn.apache.org/repos/asf/nifi/site/trunk/docs svn-docs`
+        1. Replace the `nifi` directory (site JS assets, images, etc.) by running `rsync -av ${NIFI_VERSION}-docs/nifi/ svn-docs/nifi/`
+        1. Replace the `nifi-docs/...` directories (guides, API docs, JS/CSS assets, images, etc. but _excluding_ `component` docs) by running `rsync -av --delete --exclude='components' ${NIFI_VERSION}-docs/nifi-docs/ svn-docs/nifi-docs/` (the trailing slashes are important)
+        1. Merge the component documentation by running `rsync -av ${NIFI_VERSION}/nifi-docs/components/ svn-docs/nifi-docs/components/`
+        1. (Optional) Check the status by running `svn st svn-docs`
+        1. Add the new files to version control by running `cd svn-docs && svn add . --force`
+        1. Commit the changes by running `svn ci -m "Added ${NIFI_VERSION} docs to NiFi site."`
 
 1. In JIRA mark the release version as 'Released' and 'Archived' through 'version' management in the 'administration' console.