Pacemaker has multiple forms of documentation:
The primary end-user documentation is a series of "books":
The source for these is kept beneath this directory. Generated versions are available online in epub, PDF, and HTML format at:
https://clusterlabs.org/pacemaker/doc/
Annotated source code in HTML format can be generated by running "make global" in this directory, which requires the gtags and htags tools. This is generated for releases and can be viewed online at:
Pacemaker manual pages are generated and installed automatically when building the software. HTML versions can be generated by running "make manhtml" in this directory, which requires the groff tool. This is generated for releases and can be viewed online at:
For developers, documentation for Pacemaker's public C API is generated by running "make doxygen" in this directory, which requires the doxygen tool. This is generated for releases and can be viewed online at:
Also for developers, a report of Pacemaker ABI compatibility between any two commits can be generated by running in this directory:
make LAST_RELEASE=$EARLIER_COMMIT TAG=$NEWER_COMMIT abi-www
which requires the abi-compliance-checker tool. This is generated for each release compared to the previous release and can be viewed online at:
https://clusterlabs.org/pacemaker/abi/
Each book's sources are kept in a subdirectory by title. Each book subdirectory has an en-US subdirectory with the master sources, and potentially other subdirectories for translations. However, the translations are not currently actively maintained and so are disabled.
Each book's en-US subdirectory has text files with the chapter sources in asciidoc format. The file asciidoc.reference in this directory has a quick guide to asciidoc; search online for more detailed help.
Once you have edited the asciidoc as desired, run "make" in this directory to generate all the books locally. You view the results by pointing your web browser to (replacing BOOK_TITLE appropriately):
file:///path/to/checkout/doc/BOOK\_TITLE/publish/desktop/en-US/index.html
Each en-US subdirectory also contains some raw XML files of lesser interest: