You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tephra.apache.org by po...@apache.org on 2016/09/20 06:53:53 UTC
[52/52] [abbrv] incubator-tephra git commit: Update release guide
with website documentation
Update release guide with website documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-tephra/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tephra/commit/bf06a901
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tephra/tree/bf06a901
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tephra/diff/bf06a901
Branch: refs/heads/site
Commit: bf06a901ef37ad6f2c4f92ef7a0dc4e9c80d7a80
Parents: 49c6e8b
Author: poorna <po...@apache.org>
Authored: Mon Sep 19 23:47:25 2016 -0700
Committer: poorna <po...@apache.org>
Committed: Mon Sep 19 23:47:25 2016 -0700
----------------------------------------------------------------------
src/site/markdown/ReleaseGuide.md | 89 ++++++++++++++++++++++++++++++++--
1 file changed, 85 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tephra/blob/bf06a901/src/site/markdown/ReleaseGuide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/ReleaseGuide.md b/src/site/markdown/ReleaseGuide.md
index d8334c6..e6fb7c2 100644
--- a/src/site/markdown/ReleaseGuide.md
+++ b/src/site/markdown/ReleaseGuide.md
@@ -101,7 +101,7 @@ Perform the release by running:
This will checkout the source code using the release tag, build the release and deploy it to the
repository.apache.org repository. Also it creates a source tarball
-`apache-tephra-0.8.0-incubating-SNAPSHOT-source-release.tar.gz` under the `target` directory.
+`apache-tephra-${RELEASE_VERSION}-incubating-SNAPSHOT-source-release.tar.gz` under the `target` directory.
### Prepare Release Artifacts
1. Checkin the source release tarball, together with the signature, md5 and sha512 files found in
@@ -265,9 +265,90 @@ Here is a template for the announce email:
```
## Update Website with the new Release
+Build javadocs for the release version using the command below. The javadocs for the
+release version will be under `target/site/apidocs`:
```sh
- git checkout master
- git merge release/N.N.N
- git push origin master
+git pull
+git checkout v${RELEASE_VERSION}-incubating
+mvn clean javadoc:aggregate -DskipTests
+```
+
+Merge `master` into the `site` branch:
+
+```sh
+git checkout site
+git merge --no-ff origin/master
+```
+
+Copy over the release javadocs to `src/site/resources`:
+
+```sh
+cp -r target/site/apidocs src/site/resources/apidocs-${RELEASE_VERSION}-incubating
+```
+
+Create a corresponding release markdown file `src/site/markdown/releases/${RELEASE_VERSION}-incubating.md`.
+
+Update `src/site/site.xml` to include the new release
+
+ - Update section "Documentation" to point to the javadocs for the release version.
+ - Update section "Releases" to point to the new release markdown.
+
+Update the following sections of documentation if needed
+
+ - "Getting Started" section in `site/markdown/GettingStarted.md`
+ - "Hadoop/HBase Environment" `section in site/markdown/index.md`
+
+Build javadocs for the next development version:
+
+```sh
+git checkout master
+mvn clean package javadoc:aggregate -DskipTests
+```
+
+Copy over the development javadocs to `src/site/resources`:
+
+```sh
+git checkout site
+rm -rf src/site/resources/apidocs
+cp -r target/site/apidocs src/site/resources/apidocs
+```
+
+Build the website:
+
+```sh
+mvn clean site -P site -DskipTests
+```
+
+Verify the website:
+
+```sh
+open target/site/index.html
+```
+
+Checkout Tephra site from `https://svn.apache.org/repos/asf/incubator/tephra/site` if needed:
+
+```sh
+svn co https://svn.apache.org/repos/asf/incubator/tephra [working-dir]/tephra-site
+```
+
+Rsync the files in `target/site` to `https://svn.apache.org/repos/asf/incubator/tephra/site`:
+
+```sh
+cd [tephra-src-git-dir]
+rsync -a target/site [working-dir]/tephra-site
+cd [working-dir]/tephra-site
+```
+
+Verify the website again:
+
+```sh
+open site/index.html
+```
+
+Commit the site chagnes:
+
+```sh
+svn add [new-release-dirs]
+svn commit -m "Apache Tephra site for release N.N.N"
```