Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.09 KB

README.md

File metadata and controls

62 lines (45 loc) · 2.09 KB

Apache Ratis web page

This is the source code of the website of Apache Ratis.

Hugo Installation

To render it you need hugo static site generator (https://gohugo.io/getting-started/installing) which is available for the most popular platforms as a single binary.

On OSX, this can be installed via HomeBrew: brew install hugo. For other operating system, please refer to the aforementioned Hugo documentation for installation steps.

Building

To render the final website, use the provided build.sh script. This script will generate the website in the directory public/ and also perform a license check on the source files (prior to commit).

hugo

To iteratively develop the website, you can use the serve command to start a local webserver with your content changes rendered in realtime:

hugo serve

Publishing website changes

Committers must ensure that the state of the asf-site-source and asf-site branches are in sync at all times. Committers must never make changes directly to the asf-site branch.

Content pushed to the asf-site branch is automatically published to the public website: https://ratis.incubator.apache.org

There is no automation to automatically keep these branches in sync, but a general guide is to do the following. Beware that these steps are destructive!

$ git checkout asf-site-source && //hack hack hack
$ ./build.sh
$ mv public ../
$ git checkout asf-site
$ rm -i ./*
* cp ../public/*
$ rm -i -r categories post tags
$ cp -r ../public/categories ../public/post ../public/tags .