Github user sijie commented on a diff in the pull request: https://github.com/apache/incubator-distributedlog/pull/30#discussion_r83162115 --- Diff: docs/README.md --- @@ -0,0 +1,85 @@ +This README gives an overview of how to build and contribute to the documentation of Apache DistributedLog. + +The documentation is included with the source of Apache DistributedLog in order to ensure that you always +have docs corresponding to your checked out version. The online documentation at +http://distributedlog.incubator.apache.org/docs/latest is also generated from the files found at master branch. + +# Requirements + +The dependencies are declared in the Gemfile in this directory. We use [reStructuredText](http://docutils.sourceforge.net/rst.html) +to write and [Jekyll](https://jekyllrb.com/) and [jekyll-rst](https://github.com/xdissent/jekyll-rst) to translate the documentation to static HTML. +You can use Ruby's Bundler Gem to install all the depenencies for building the documentation: + + gem install bundler + bundle install + +And use [pip](https://pypi.python.org/pypi/pip) to install docutils and pygments + + pip install docutils pygments + +# Build + +## Live developement + +While you are working with the documentation, you can test and develop live. Run the following in the root folder of the `docs`: + + $ bundle exec jekyll serve + +Jekyll will start a webserver on port `4000`. As you make changes to the content, Jekyll will rebuild it automatically. +This is helpful if you want to see how your changes will render in realtime. + +## Generating the static website + +Once you are done with your changes, you need to compile the static content for the website. --- End diff -- yup. I added a sentence for the minimal ruby version.
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---