Mesos Markdown Style Guide

This guide introduces a consistent documentation style to be used across the entire non-code documentation. User guides and non-code technical documentation are stored in markdown files in the docs/ folder. These files get rendered for the online documentation.

NOTE: As of right now this is work in progress and the existing documentation might not yet comply to this style.

What to document?

Any new substantial feature should be documented in its own markdown file. If the link between source code and documentation is not obvious, consider inserting a short code comment stating that there is non-code documentation that needs to be kept in sync and indicating where it is located.

Keep documentation and style-guides in sync with code.

When changing code consider whether you need to update the documentation. This is especially relevant when introducing new or updating existing command line flags. These should be reflected in!

Code Examples

Code examples should be specified as follows:

int main(int argc, char** argv)

NOTE: Because of shortcomings of Doxygen's markdown parser we currently use indentation for wrapping all non C++ code blocks.


Notes are used to highlight important parts of the text and should be specified as follows.

**NOTE:**  Short note.
Continued longer note.

We use single backticks to highlight individual words in a sentence such as certain identifiers:

Use the default `HierarchicalDRF` allocator....


We use single backticks to highlight sample commands as follows:

`mesos-master --help`


Files and path references should be specified as follows:

Remember you can also use the `file:///path/to/file` or `/path/to/file`


In order to avoid problems with markdown formatting we should specify tables in html directly:

<table class="table table-striped">
      <th width="30%">
      IP address to listen on
      Prints this help message (default: false)


Indendation and Whitespace

We use no extra indentation in markdown files. We have one new line after section headings and two blank lines in between sections.

... end of previous section.

## New Section

Beginning of new section ....