Apache Ratis docs

This subproject contains the inline documentation for Apache Ratis.

View rendered documents

To view the documents locally, you can run:

cd ratis-docs
mvn site:run

Then visit http://localhost:8080/ to view rendered documents.

Write document

To create new document, please add markdown files into src/site/markdown folder, and then create a link in site.xml. For example, site/markdown/cli.md could be accessed by cli.html.

For more about the usage, please refer to the documentation of maven-site-plugin.