You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2018/11/28 05:03:29 UTC
nifi-site git commit: Added instructions on maintaining existing
versions of component documentation to Release Guide.
Repository: nifi-site
Updated Branches:
refs/heads/master bdeef60f2 -> 14e0e8660
Added instructions on maintaining existing versions of component documentation to Release Guide.
Project: http://git-wip-us.apache.org/repos/asf/nifi-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi-site/commit/14e0e866
Tree: http://git-wip-us.apache.org/repos/asf/nifi-site/tree/14e0e866
Diff: http://git-wip-us.apache.org/repos/asf/nifi-site/diff/14e0e866
Branch: refs/heads/master
Commit: 14e0e86601c39f1c67c379e04d374a6192d6c3ad
Parents: bdeef60
Author: Andy LoPresto <al...@apache.org>
Authored: Tue Nov 27 21:00:03 2018 -0800
Committer: Andy LoPresto <al...@apache.org>
Committed: Tue Nov 27 21:00:03 2018 -0800
----------------------------------------------------------------------
src/pages/markdown/release-guide.md | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/nifi-site/blob/14e0e866/src/pages/markdown/release-guide.md
----------------------------------------------------------------------
diff --git a/src/pages/markdown/release-guide.md b/src/pages/markdown/release-guide.md
index acef254..46ef9ba 100644
--- a/src/pages/markdown/release-guide.md
+++ b/src/pages/markdown/release-guide.md
@@ -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.