| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title></title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <link href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet"> |
| <link rel="alternate" type="application/atom+xml" title="Apache Mesos Blog" href="/blog/feed.xml"> |
| |
| <link href="../../assets/css/main.css" media="screen" rel="stylesheet" type="text/css" /> |
| |
| |
| |
| <!-- Google Analytics Magic --> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-20226872-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script> |
| </head> |
| <body> |
| <!-- magical breadcrumbs --> |
| <div class="topnav"> |
| <ul class="breadcrumb"> |
| <li> |
| <div class="dropdown"> |
| <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> |
| <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> |
| <li><a href="http://www.apache.org">Apache Homepage</a></li> |
| <li><a href="http://www.apache.org/licenses/">License</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li><a href="http://www.apache.org/security/">Security</a></li> |
| </ul> |
| </div> |
| </li> |
| <li><a href="http://mesos.apache.org">Apache Mesos</a></li> |
| |
| |
| <li><a href="/documentation |
| /">Documentation |
| </a></li> |
| |
| |
| </ul><!-- /breadcrumb --> |
| </div> |
| |
| <!-- navbar excitement --> |
| <div class="navbar navbar-static-top" role="navigation"> |
| <div class="navbar-inner"> |
| <div class="container"> |
| <a href="/" class="logo"><img src="/assets/img/mesos_logo.png" alt="Apache Mesos logo" /></a> |
| <div class="nav-collapse"> |
| <ul class="nav nav-pills navbar-right"> |
| <li><a href="/gettingstarted/">Getting Started</a></li> |
| <li><a href="/documentation/latest/">Documentation</a></li> |
| <li><a href="/downloads/">Downloads</a></li> |
| <li><a href="/community/">Community</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div><!-- /.navbar --> |
| |
| <div class="container"> |
| |
| <div class="row-fluid"> |
| <div class="col-md-4"> |
| <h4>If you're new to Mesos</h4> |
| <p>See the <a href="/gettingstarted/">getting started</a> page for more information about downloading, building, and deploying Mesos.</p> |
| |
| <h4>If you'd like to get involved or you're looking for support</h4> |
| <p>See our <a href="/community/">community</a> page for more details.</p> |
| </div> |
| <div class="col-md-8"> |
| <h1>Mesos Documentation Guide</h1> |
| |
| <p>Documentation is an integral part of every good feature. It describes the intended usage and enables new users to start using and understanding the feature.</p> |
| |
| <p>We have three different kinds of documentation:</p> |
| |
| <ol> |
| <li><a href="/documentation/latest/mesos-markdown-style-guide/">MarkDown User Guides</a></li> |
| </ol> |
| |
| |
| <p> User guides and non-code technical documentation are stored in markdown files in the <code>docs/</code> folder. These files get rendered for the <a href="http://mesos.apache.org/documentation/latest/">online documentation</a>.</p> |
| |
| <ol> |
| <li><a href="/documentation/latest/mesos-doxygen-style-guide/">Doxygen API Documentation and Developer Guides as part of source code</a></li> |
| </ol> |
| |
| |
| <p> Doxygen API documentation needs only to be applied to source code parts that |
| constitute an interface for which we want to generate Mesos API documentation |
| files. Implementation code that does not participate in this should still be |
| enhanced by source code comments as appropriate, but these comments should not follow the doxygen style.</p> |
| |
| <p> Substantial libraries, components, and subcomponents of the Mesos system such as |
| stout, libprocess, master, slave, containerizer, allocator, and others |
| should have an overview page in markdown format that explains their |
| purpose, overall structure, and general use. This can even be a complete developer guide.</p> |
| |
| <ol> |
| <li>Regular source code documentation</li> |
| </ol> |
| |
| |
| <p> All other source code comments must follow the <a href="https://google-styleguide.googlecode.com/svn/trunk/cppguide.html#Comments">Google Style Guide</a>.</p> |
| |
| <h2>Conventions</h2> |
| |
| <p>We follow the <a href="https://www.ietf.org/rfc/rfc2119.txt">IETF RFC 2119</a> |
| on how to use words such as “must”, “should”, “can”, |
| and other requirement-related notions.</p> |
| |
| </div> |
| </div> |
| |
| |
| <hr> |
| |
| <!-- footer --> |
| <div class="footer"> |
| <p>© 2012-2015 <a href="http://apache.org">The Apache Software Foundation</a>. |
| Apache Mesos, the Apache feather logo, and the Apache Mesos project logo are trademarks of The Apache Software Foundation.<p> |
| </div><!-- /footer --> |
| |
| </div> <!-- /container --> |
| |
| <!-- JS --> |
| <script src="//code.jquery.com/jquery-1.11.0.min.js" type="text/javascript"></script> |
| <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js" type="text/javascript"></script> |
| </body> |
| </html> |
