accumulo-commits mailing list archives

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


Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/3de6faf8
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/3de6faf8
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/3de6faf8

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

----------------------------------------------------------------------
 releasing.md | 15 +++++------
 source.md    | 77 ++++++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 60 insertions(+), 32 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/3de6faf8/releasing.md
----------------------------------------------------------------------
diff --git a/releasing.md b/releasing.md
index e706885..132e043 100644
--- a/releasing.md
+++ b/releasing.md
@@ -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. https://accumulo.staging.apache.org/1.6/apidocs)
-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. https://accumulo.apache.org/1.6/apidocs)
 
 ## References
@@ -144,5 +144,4 @@ Some good references that explain a few things:
 [6]: http://accumulo.apache.org/governance/releasing.html
 [7]: http://www.kb.cert.org/vuls/id/225657
 [8]: http://www.apache.org/dev/cmsref#extpaths
-[9]: https://svn.apache.org/repos/asf/accumulo/site/trunk
 [addrelease]: https://reporter.apache.org/addrelease.html?accumulo

http://git-wip-us.apache.org/repos/asf/accumulo/blob/3de6faf8/source.md
----------------------------------------------------------------------
diff --git a/source.md b/source.md
index 61823f8..fe1a3fd 100644
--- a/source.md
+++ b/source.md
@@ -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
reviews.
 
 Accumulo's release guide can be found [here][release].
 
-[subversion]: http://subversion.apache.org/
-[sitesvn]: https://svn.apache.org/repos/asf/accumulo/site/
-[maven]: http://maven.apache.org/
-[srcheaders]: http://www.apache.org/legal/src-headers.html
-[styles]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=tree;f=contrib;hb=HEAD
-[jenkins]: http://jenkins-ci.org/
-[masterbuild]: https://builds.apache.org/job/Accumulo-Master/
-[17build]: https://builds.apache.org/job/Accumulo-1.7/
 [16build]: https://builds.apache.org/job/Accumulo-1.6/
-[jiraloc]: https://issues.apache.org/jira/browse/accumulo
-[jira]: http://www.atlassian.com/software/jira/overview
-[devlist]: mailto:dev@accumulo.apache.org
-[release]: governance/releasing.html
+[17build]: https://builds.apache.org/job/Accumulo-1.7/
+[1]: http://creadur.apache.org/rat/apache-rat-plugin/
+[anongit]: git://git.apache.org/accumulo.git
+[cgit]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=summary
 [cms]: http://www.apache.org/dev/cms.html
-[cmsusage]: http://www.apache.org/dev/cms.html#usage
 [cmsanon]: http://www.apache.org/dev/cmsref.html#non-committer
-[git]: http://git-scm.com/
-[cgit]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=summary
-[anongit]: git://git.apache.org/accumulo.git
-[rb]: rb.html
-[pom]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=blob_plain;f=pom.xml;hb=HEAD
-[lifecycle]: https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
-[1]: http://creadur.apache.org/rat/apache-rat-plugin/
+[cmsusage]: http://www.apache.org/dev/cms.html#usage
+[contrib]: contrib.html
+[devlist]: mailto:dev@accumulo.apache.org
+[gh-pages]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=tree;h=gh-pages
 [git-instr]: https://git-wip-us.apache.org
+[git]: http://git-scm.com/
+[github]: https://github.com/apache/accumulo
+[hook]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=blob_plain;f=_devtools/git-hooks/post-commit;hb=gh-pages
 [intellij-formatter]: https://code.google.com/p/eclipse-code-formatter-intellij-plugin
-[contrib]: contrib.html
+[jekyll]: https://jekyllrb.com/
+[jenkins]: http://jenkins-ci.org/
+[jira]: http://www.atlassian.com/software/jira/overview
+[jiraloc]: https://issues.apache.org/jira/browse/ACCUMULO
+[lifecycle]: https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html
+[masterbuild]: https://builds.apache.org/job/Accumulo-Master/
+[maven]: http://maven.apache.org/
+[pom]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=blob_plain;f=pom.xml;hb=HEAD
+[rb]: rb.html
+[release]: governance/releasing.html
+[site-canon]: https://accumulo.apache.org
+[site-mirror]: http://apache.github.io/accumulo
+[srcheaders]: http://www.apache.org/legal/src-headers.html
+[styles]: https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=tree;f=contrib;hb=HEAD


Mime
View raw message