accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [2/2] accumulo git commit: Update site instructions
Date Mon, 14 Mar 2016 23:50:47 GMT
Update site instructions


Branch: refs/heads/gh-pages
Commit: 3de6faf86bcf4cd6f416765801c789b607b7ed05
Parents: 0908bb7
Author: Christopher Tubbs <>
Authored: Mon Mar 14 19:44:50 2016 -0400
Committer: Christopher Tubbs <>
Committed: Mon Mar 14 19:44:50 2016 -0400

---------------------------------------------------------------------- | 15 +++++------    | 77 ++++++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 60 insertions(+), 32 deletions(-)
diff --git a/ b/
index e706885..132e043 100644
--- a/
+++ b/
@@ -117,13 +117,13 @@ to avoid known [vulnerabilities][7]), follow these steps:
 1. Unpack the source release tarball and change to its root directory, or checkout the SCM
tag for the release
 2. Build the javadocs with `mvn clean package javadoc:aggregate -DskipTests -Paggregate-javadocs`
 3. Take note that the javadocs you will need to copy are the entire contents of `./target/site/apidocs/`
-4. Checkout the [Accumulo CMS repository][9]
-5. Remove any existing apidocs from the appropriate version folder in the CMS repository
(e.g. content/1.6/apidocs for a 1.6.x release)
-6. Copy the entire contents of the new apidocs directory (identified in step 3) to the CMS
repository (e.g. to content/1.6/apidocs)
-7. Commit the changes
-8. Wait for the staging build to complete
-9. Verify the javadocs have been published to the staging site (e.g.
-10. Continue updating the staging site, as needed, and publish when done
+4. Checkout the `gh-pages` branch (you may need to move the contents of `./target/site/apidocs`
outside your git workspace to switch branches)
+5. Remove any existing apidocs from the appropriate version folder (e.g. 1.6/apidocs for
a 1.6.x release)
+6. Copy the entire contents of the new apidocs directory (identified in step 3) to the destination
(e.g. to 1.6/apidocs)
+7. Continue updating the site content, as needed
+8. Commit the changes
+9. Update the site using jekyll with `./_devtools/git-hooks/post-commit` (if you don't have
the commit hook already configured)
+10. Don't forget to push both the `gh-pages` and `asf-site` branches
 11. Verify that javadocs have been updated on the production site (e.g.
 ## References
@@ -144,5 +144,4 @@ Some good references that explain a few things:
diff --git a/ b/
index 61823f8..fe1a3fd 100644
--- a/
+++ b/
@@ -28,9 +28,34 @@ Accumulo has a number of [contrib projects][contrib] that maintain their
own cod
 ### Website
-Accumulo's web site is maintained with [Apache Subversion][subversion] [here][sitesvn] using
Apache's [Content Management System][cms].
-Committers may edit the site by following [these instructions][cmsusage].  Non-committers
should follow
-[this FAQ entry][cmsanon].
+Accumulo's web site is developed using [Jekyll][jekyll]. Development is
+performed by editing the contents of the [gh-pages][gh-pages] branch, either
+directly by a committer, with a pull request to [GitHub][github], or a patch
+submitted to [JIRA][jiraloc]. The rendered site can be previewed locally or on
+[GitHub][site-mirror], and the rendered site (in the `_site` directory) will be
+merged into the `asf-site` branch to update our [official/canonical
+site][site-canon] after being built with the `_config-asf.yml` configuration.
+To get help with jekyll:
+    jekyll help
+To test the site locally (usually on http://localhost:4000):
+    jekyll serve --config _config-asf.yml --safe
+To build for updating the `asf-site` branch:
+    jekyll build --config _config-asf.yml --safe
+For preview convenience and consistent builds and testing, build using a
+version which looks the same locally and on GitHub.
+A [post-commit hook][hook] is available for you to automatically create a
+commit in the `asf-site` branch locally each time you commit to the `gh-pages`
+branch. You can also run this command manually:
+    ./_devtools/git-hooks/post-commit
 ## Developer's Guide
@@ -163,29 +188,33 @@ Accumulo has [guidelines for using Review Board][rb] to support code
 Accumulo's release guide can be found [here][release].
-[release]: governance/releasing.html
+[anongit]: git://
-[anongit]: git://
-[rb]: rb.html
+[contrib]: contrib.html
-[contrib]: contrib.html
+[rb]: rb.html
+[release]: governance/releasing.html

View raw message