ACCUMULO-4734 Changes from review of tour (#43)


9 files changed
tree: 3cc1a71b4c5a5e660b9b77f733abc254db39344d
  1. .gitignore
  2. .travis.yml
  3. 1.3/
  4. 1.4/
  5. 1.5/
  6. 1.6/
  7. 1.7/
  8. 1.8/
  9. Gemfile
  10. Gemfile.lock
  11. README.md
  12. _config.yml
  13. _data/
  14. _devtools/
  15. _docs-2-0/
  16. _includes/
  17. _layouts/
  18. _posts/
  19. _sass/
  20. contributor/
  21. css/
  22. doap_Accumulo.rdf
  23. favicon.ico
  24. favicon.png
  25. feed.xml
  26. images/
  27. index.html
  28. latest/
  29. pages/
  30. papers/
  31. tour/
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

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.

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).

./_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/