You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by el...@apache.org on 2016/04/17 20:22:53 UTC
[1/2] accumulo git commit: Recommend using bundler instead of
installing gems by hand.
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 <el...@apache.org>
Authored: Sun Apr 17 14:20:58 2016 -0400
Committer: Josh Elser <el...@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
[2/2] accumulo git commit: Jekyll build from gh-pages:b02b3d2
Posted by el...@apache.org.
Jekyll build from gh-pages:b02b3d2
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/2b944834
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/2b944834
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/2b944834
Branch: refs/heads/asf-site
Commit: 2b944834feef56428cccf68c9f73c31df2646ea6
Parents: c4ac543
Author: Josh Elser <el...@apache.org>
Authored: Sun Apr 17 14:20:58 2016 -0400
Committer: Josh Elser <el...@apache.org>
Committed: Sun Apr 17 14:21:20 2016 -0400
----------------------------------------------------------------------
README.md | 30 ++++++++++++++++++++++++++++++
feed.xml | 4 ++--
source.html | 27 +++++++++++++++++++++++++++
3 files changed, 59 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo/blob/2b944834/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/2b944834/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index 51cb634..827add2 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
</description>
<link>https://accumulo.apache.org/</link>
<atom:link href="https://accumulo.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Sun, 17 Apr 2016 14:10:43 -0400</pubDate>
- <lastBuildDate>Sun, 17 Apr 2016 14:10:43 -0400</lastBuildDate>
+ <pubDate>Sun, 17 Apr 2016 14:21:16 -0400</pubDate>
+ <lastBuildDate>Sun, 17 Apr 2016 14:21:16 -0400</lastBuildDate>
<generator>Jekyll v3.0.3</generator>
</channel>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/2b944834/source.html
----------------------------------------------------------------------
diff --git a/source.html b/source.html
index f50c192..9ee6d27 100644
--- a/source.html
+++ b/source.html
@@ -230,6 +230,14 @@ submitted to <a href="https://issues.apache.org/jira/browse/ACCUMULO">JIRA</a>.
merged into the <code class="highlighter-rouge">asf-site</code> branch to update our <a href="https://accumulo.apache.org">official/canonical
site</a> after being built with the <code class="highlighter-rouge">_config-asf.yml</code> configuration.</p>
+<p>To manage any Gem dependencies, it is highly recommended to use <a href="https://bundler.io">Bundler</a>.
+To start using Bundler, install it and then the dependencies for the website:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>gem install bundler
+bundle install
+</code></pre>
+</div>
+
<p>To get help with jekyll:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>jekyll help
@@ -242,12 +250,24 @@ site</a> after being built with the <code class="highlighter-rouge">_config-asf.
</code></pre>
</div>
+<p>To do the same with Bundler:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>bundle exec jekyll serve --config _config-asf.yml --safe
+</code></pre>
+</div>
+
<p>To build for updating the <code class="highlighter-rouge">asf-site</code> branch:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>jekyll build --config _config-asf.yml --safe
</code></pre>
</div>
+<p>To do the same with Bundler:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>bundle exec jekyll build --config _config-asf.yml --safe
+</code></pre>
+</div>
+
<p>For preview convenience and consistent builds and testing, build using a
version which looks the same locally and on GitHub.</p>
@@ -259,6 +279,13 @@ branch. You can also run this command manually:</p>
</code></pre>
</div>
+<p>To automatically run this post-commit hook in your local repository, copy
+the given file into your <code class="highlighter-rouge">.git/hook</code> directory:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>`cp ./_devtools/git-hooks/post-commit .git/hooks/`
+</code></pre>
+</div>
+
<h2 id="developers-guide">Developer’s Guide</h2>
<h3 id="building">Building</h3>