Google Git
Sign in
apache / accumulo-website / 6799d7103c638bbffd7473956b1b6508fa397796
commit6799d7103c638bbffd7473956b1b6508fa397796[log] [tgz]
authorChristopher Tubbs <ctubbsii@apache.org>Mon Apr 23 13:21:38 2018 -0400
committerChristopher Tubbs <ctubbsii@apache.org>Mon Apr 23 13:21:38 2018 -0400
treeac436bcc6fe0fd9863158a7c5c5bab801825d8d1
parentf8969a1c207d65bca7d3c5d6857ed04e81dcd83c [diff]
Add 1.9.0 manual and examples
2 files changed
tree: ac436bcc6fe0fd9863158a7c5c5bab801825d8d1
  1. 1.3/
  2. 1.4/
  3. 1.5/
  4. 1.6/
  5. 1.7/
  6. 1.8/
  7. 1.9/
  8. _data/
  9. _devtools/
  10. _docs-2-0/
  11. _includes/
  12. _layouts/
  13. _posts/
  14. _sass/
  15. contributor/
  16. css/
  17. images/
  18. latest/
  19. pages/
  20. papers/
  21. tour/
  22. .gitignore
  23. .travis.yml
  24. _config.yml
  25. CONTRIBUTING.md
  26. doap_Accumulo.rdf
  27. favicon.ico
  28. favicon.png
  29. feed.xml
  30. Gemfile
  31. Gemfile.lock
  32. index.html
  33. README.md
README.md

Apache Accumulo Website

Apache Accumulo uses Jekyll to build their website. It is recommended that you use Bundler to install the necessary dependencies to run and build the website.

Install Bundler and dependencies

Ruby is required to use Bundler so first make sure you have Ruby on your machine. If you are using an OS packaged version of Ruby, you will have to also install the ruby-dev (Ubuntu) or ruby-devel (Fedora) package as well.

With Ruby installed on your machine, you can install Bundler using the command below:

gem install bundler

Next, use Bundler to install Jekyll and other dependencies needed to run the website.

git clone https://github.com/apache/accumulo-website
cd accumulo-website
bundle install

Run the website locally

Run the following command to run the website locally using Jekyll's embedded webserver:

cd accumulo-website
bundle exec jekyll serve -w

The website can viewed at http://0.0.0.0:4000/

Build website static HTML files

You can just build static HTML files which are viewable in _config.yml:

cd accumulo-website
bundle exec jekyll build

Update the production website

For Apache Accumulo committers, the asf-site branch needs to be updated with the generated HTML. Changes to this branch are automagically mirrored to the website.

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). The commands below are a guide for committers who wish to publish the web site.

# ensure local asf-site branch is up to date
git checkout asf-site
git pull upstream asf-site

# switch to master branch, update it, and build new site
git checkout master
git pull upstream master
./_devtools/git-hooks/post-commit

# switch to asf-site, look at the commit created by post-commit script, and push it if ok
git checkout asf-site
git log -p
git push upstream asf-site

In the commands above upstream is :

$ git remote -v | grep upstream
upstream	https://gitbox.apache.org/repos/asf/accumulo-website/ (fetch)
upstream	https://gitbox.apache.org/repos/asf/accumulo-website/ (push)

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/