tree: a5bc8feed9f412731126455246cf592cdd0f1fb3 [path history] [tgz]
  1. .gitignore
  2. Gemfile
  3. Gemfile.lock
  4. Makefile
  5. README.md
  6. Rakefile
  7. _config-apache.yml
  8. _config-local.yml
  9. _config-production.yml
  10. _config-staging.yml
  11. _config.yml
  12. _data/
  13. _distributedlog_team/
  14. _includes/
  15. _layouts/
  16. _mentors/
  17. _posts/
  18. _sass/
  19. blog/
  20. build-javadoc.sh
  21. build.sh
  22. coming-soon.md
  23. community/
  24. contribute.md
  25. css/
  26. docker/
  27. docs/
  28. faq.md
  29. feed.xml
  30. fonts/
  31. images/
  32. index.md
  33. js/
  34. project/
  35. scripts/
  36. styles/
website/README.md

Apache DistributedLog website

This is the website for Apache DistributedLog.

About this site

The DistributedLog website is built using Jekyll. Additionally, for additional formatting capabilities, this website uses Twitter Bootstrap.

This website is hosted at:

http://bookkeeper.apache.org/distributedlog

It is important to note there are two sets of “website code” with respect to the Apache DistributedLog website.

  1. The Jekyll code which contains all of the resources for building, testing, styling, and tinkering with the website. Think of it as a website SDK.
  2. The static website content which contains the content for the website. This is the static content is what is actually hosted on the Apache DistributedLog website.

Development setup

First, make sure you have Ruby installed. The minimal ruby version is 2.0.0.

Before working with the Jekyll code, you can use Ruby's Bundler Gem to install all the dependencies for building this website:

gem install bundler
bundle install

If you are on a Mac, you may need to install Ruby Gems.

And use pip to install docutils and pygments required for building the documentation:

pip install docutils pygments

Build website together with documentation

You can run the build.sh at the root folder of website to build a local site.

$ build.sh local

You can also build with the production settings. It will generate the content that is actually hosted in distributedlog website.

$ build.sh production

Once built, it will be placed in the folder content inside of the root directory. This directory will include images, HTML, CSS and so on. In a typical Jekyll install this content will live in _site - it has been changed for Apache DistributedLog website to work with the ASF Incubator publishing system.

Run the server locally

You can run bundle exec jekyll serve locally to serve the generated static content to verify if the website works as expected.

$ bundle exec jekyll serve