The ZooKeeper website is built using Jekyll formatted in Markdown. The production website is updated using gitpubsub via the zookeeper.git/asf-site branch. Basic workflow is: modify the site source on the "website" branch and commit it once you are happy with the results, then update the "asf-site" branch with the generated content. Once asf-site is pushed the updates will be reflected on the ZooKeeper production website.
The content source to generate the ZooKeeper website can be found here: https://git-wip-us.apache.org/repos/asf?p=zookeeper.git;a=shortlog;h=refs/heads/website
The live website is whatever is committed to asf-site, here: https://git-wip-us.apache.org/repos/asf?p=zookeeper.git;a=shortlog;h=refs/heads/asf-site . Any changed committed to this branch are immediately replicated to the live production website at http://zookeeper.apache.org/
Information on running the website generation process can be found in the README.md file on the website branch, similar for managing the asf-site.
The ZooKeeper website build uses a number of tools.
$ sudo gem install jekyll jekyll-redirect-from pygments.rb $ sudo pip install Pygments
(Note: If you are on a system with both Ruby 1.9 and Ruby 2.0 you may need to replace gem with gem2.0)
Steps to update the site:
git clone -b website https:
- update the appropriate pages, typically a markdown file e.g. credits.md, etc...
cp -RP _released_docs _site/doc # these are the static release docs, they are not generated
point verify that the generated files render properly - open _site/index.html in the browser
# if you are happy with the results move on to the next step..., otherwise goto step 2 above.
git add <the changed files>
git commit -m
"<appropriate commit message>"
- git push origin website
- # the source for the site is committed, now we need to push the generated files to the live site...
git checkout asf-site
rm -fr content
- mv _site content
- git add content
- # verify that content/index.html and other generated files are proper, open in a browser
"git status" should show modified files for the markdown that you changed
- git commit -m "<appropriate commit message>"
- git push origin asf-site