accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From els...@apache.org
Subject [1/2] accumulo git commit: Recommend using bundler instead of installing gems by hand.
Date Sun, 17 Apr 2016 18:22:53 GMT
Repository: accumulo
Updated Branches:
  refs/heads/asf-site c4ac54300 -> 2b944834f
  refs/heads/gh-pages 16beffdfc -> b02b3d2be


Recommend using bundler instead of installing gems by hand.


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

Branch: refs/heads/gh-pages
Commit: b02b3d2be41be18115c77d1333506c31eda352e1
Parents: 16beffd
Author: Josh Elser <elserj@apache.org>
Authored: Sun Apr 17 14:20:58 2016 -0400
Committer: Josh Elser <elserj@apache.org>
Committed: Sun Apr 17 14:20:58 2016 -0400

----------------------------------------------------------------------
 README.md | 30 ++++++++++++++++++++++++++++++
 source.md | 19 +++++++++++++++++++
 2 files changed, 49 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo/blob/b02b3d2b/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97f29cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Apache Accumulo Website
+
+Apache Accumulo uses [Jekyll](http://jekyllrb.com/) to build their website. It is recommended
+that you use [Bundler](http://bundler.io/) to manage any dependencies of the build for you.
+
+## Install Bundler and dependencies
+
+`gem install bundler`
+`bundle install`
+
+## Build the website
+
+Jekyll lets you either build the static HTML files or create an embedded webserver
+to interact with the local version of the website.
+
+`bundle exec jekyll build`
+
+or
+
+`bundle exec jekyll serve -w`
+
+## Update the production website
+
+For Apache Accumulo committers, the `asf-site` branch needs to be updated with the generated
+HTML.
+
+This can be done easily by invoking the post-commit hook (either by hand, or automatically
via configuring
+Git to invoke the post-commit hook).
+
+`./.devsupport/git-hooks/post-commit`

http://git-wip-us.apache.org/repos/asf/accumulo/blob/b02b3d2b/source.md
----------------------------------------------------------------------
diff --git a/source.md b/source.md
index fe1a3fd..240bc2e 100644
--- a/source.md
+++ b/source.md
@@ -36,6 +36,12 @@ submitted to [JIRA][jiraloc]. The rendered site can be previewed locally
or on
 merged into the `asf-site` branch to update our [official/canonical
 site][site-canon] after being built with the `_config-asf.yml` configuration.
 
+To manage any Gem dependencies, it is highly recommended to use [Bundler](https://bundler.io).
+To start using Bundler, install it and then the dependencies for the website:
+
+    gem install bundler
+    bundle install
+
 To get help with jekyll:
 
     jekyll help
@@ -44,10 +50,18 @@ To test the site locally (usually on http://localhost:4000):
 
     jekyll serve --config _config-asf.yml --safe
 
+To do the same with Bundler:
+
+    bundle exec jekyll serve --config _config-asf.yml --safe
+
 To build for updating the `asf-site` branch:
 
     jekyll build --config _config-asf.yml --safe
 
+To do the same with Bundler:
+
+    bundle exec 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.
 
@@ -57,6 +71,11 @@ branch. You can also run this command manually:
 
     ./_devtools/git-hooks/post-commit
 
+To automatically run this post-commit hook in your local repository, copy
+the given file into your `.git/hook` directory:
+
+    `cp ./_devtools/git-hooks/post-commit .git/hooks/`
+
 ## Developer's Guide
 
 ### Building


Mime
View raw message