You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by dl...@apache.org on 2015/06/13 22:31:49 UTC

svn commit: r1685322 [3/3] - in /mesos/site: publish/ publish/documentation/ publish/documentation/configuration/ publish/documentation/engineering-principles-and-practices/ publish/documentation/getting-started/ publish/documentation/latest/ publish/d...

Modified: mesos/site/source/documentation/latest.html.md
URL: http://svn.apache.org/viewvc/mesos/site/source/documentation/latest.html.md?rev=1685322&r1=1685321&r2=1685322&view=diff
==============================================================================
--- mesos/site/source/documentation/latest.html.md (original)
+++ mesos/site/source/documentation/latest.html.md Sat Jun 13 20:31:48 2015
@@ -33,20 +33,24 @@ layout: documentation
 * [Framework Development Guide](/documentation/latest/app-framework-development-guide/) describes how to build applications on top of Mesos.
 * [Reconciliation](/documentation/latest/reconciliation/) for ensuring a framework's state remains eventually consistent in the face of failures.
 * [Javadoc](/api/latest/java/) documents the Mesos Java API.
+* [Doxygen](/api/latest/c++/namespacemesos.html) documents the Mesos C++ API.
 * [Developer Tools](/documentation/latest/tools/) for hacking on Mesos or writing frameworks.
 
 ## Mesos Modules
 
-* [Mesos Modules](/documentation/latest/modules/) for specifying mesos modules for master, slave and tests.
+* [Mesos Modules](/documentation/latest/modules/) for specifying Mesos modules for master, slave and tests.
 
 ## Contributing to Mesos
 
 * [Reporting an Issue, Improvement, or Feature](/documentation/latest/reporting-a-bug/) for getting started with JIRA.
 * [Submitting a Patch](/documentation/latest/submitting-a-patch/) for getting started with ReviewBoard, and our tooling around it.
 * [Effective Code Reviewing](/documentation/latest/effective-code-reviewing/) guidelines, tips, and learnings for how to do effective code reviews.
+* [Engineering Principles and Practices](/documentation/latest/engineering-principles-and-practices/) to serve as a shared set of project-level values for the community.
 * [Committing](/documentation/latest/committing/) guidelines for committing changes.
 * [Committers and Maintainers](/documentation/latest/committers/) a listing of project committers and component maintainers; useful when seeking feedback.
+* [Doxygen](/api/latest/c++/) documents the internal Mesos APIs.
 * [C++ Style Guide](/documentation/latest/mesos-c++-style-guide/)
+* [Doxygen Style Guide](/documentation/latest/mesos-doxygen-style-guide/)
 * [Development Roadmap](/documentation/latest/mesos-roadmap/)
 * [Release Guide](/documentation/latest/release-guide/)
 

Modified: mesos/site/source/documentation/latest/configuration.md
URL: http://svn.apache.org/viewvc/mesos/site/source/documentation/latest/configuration.md?rev=1685322&r1=1685321&r2=1685322&view=diff
==============================================================================
--- mesos/site/source/documentation/latest/configuration.md (original)
+++ mesos/site/source/documentation/latest/configuration.md Sat Jun 13 20:31:48 2015
@@ -42,6 +42,29 @@ If you have special compilation requirem
   </tr>
   <tr>
     <td>
+      --firewall_rules=VALUE
+    </td>
+    <td>
+      The value could be a JSON formatted string of rules or a file path
+      containing the JSON formated rules used in the endpoints firewall. Path
+      could be of the form <code>file:///path/to/file</code> or
+      <code>/path/to/file</code>.
+      <p/>
+      See the Firewall message in flags.proto for the expected format.
+      <p/>
+      Example:
+<pre><code>{
+  "disabled_endpoints" : {
+    "paths" : [
+      "/files/browse.json",
+      "/slave(0)/stats.json",
+    ]
+  }
+}</code></pre>
+    </td>
+  </tr>
+  <tr>
+    <td>
       --[no-]help
     </td>
     <td>

Added: mesos/site/source/documentation/latest/engineering-principles-and-practices.md
URL: http://svn.apache.org/viewvc/mesos/site/source/documentation/latest/engineering-principles-and-practices.md?rev=1685322&view=auto
==============================================================================
--- mesos/site/source/documentation/latest/engineering-principles-and-practices.md (added)
+++ mesos/site/source/documentation/latest/engineering-principles-and-practices.md Sat Jun 13 20:31:48 2015
@@ -0,0 +1,33 @@
+---
+layout: documentation
+---
+
+# Engineering Principles and Practices
+
+This document is an attempt to capture a shared set of values for the project.
+Many companies rely on Mesos as a foundational layer of their software
+infrastructure and it is imperative that we ship **robust, high quality**
+code. We aim to foster a culture where we can trust and rely upon the work of
+the community.
+
+The following are some of the aspirational principles and practices that
+guide us:
+
+1. We value **craftsmanship**: code should be easy to read and understand,
+   should be written with high attention to detail, and should be consistent
+   in its style. Code is written for humans to read and maintain!
+2. We value **resiliency**: our system must be highly-available, stable, and
+   backwards-compatible. We must consider the implications of failures.
+3. We value **accountability**: we own and support our software, and are
+   accountable for improving it, fixing issues, and learning from our mistakes.
+4. We value **design and code review**: review helps us maintain a high
+   quality system architecture and high quality code, it also helps us mentor
+   new contributors, learn to collaborate more effectively, and reduce the
+   amount of mistakes.
+5. We value **automated testing**: automated testing allows us to iterate and
+   refactor in our large codebase, while verifying correctness and preventing
+   regression.
+6. We value **benchmarking**: benchmarking allows us to identify the right
+   locations to target performance improvements. It also allows us to iterate
+   and refactor in our large codebase, while observing the performance
+   implications.
\ No newline at end of file

Modified: mesos/site/source/documentation/latest/getting-started.md
URL: http://svn.apache.org/viewvc/mesos/site/source/documentation/latest/getting-started.md?rev=1685322&r1=1685321&r2=1685322&view=diff
==============================================================================
--- mesos/site/source/documentation/latest/getting-started.md (original)
+++ mesos/site/source/documentation/latest/getting-started.md Sat Jun 13 20:31:48 2015
@@ -21,44 +21,45 @@ There are different ways you can get Mes
 
 -  Mesos runs on Linux (64 Bit) and Mac OSX (64 Bit).
 
-### Ubuntu 12.04
+### Ubuntu
 
--  Following are the instructions for stock Ubuntu 12.04 64 Bit. If you are using a different OS please install the packages accordingly.
+The following assumes a stock install of Ubuntu 14.04 LTS, to which you should add a current
+Java JDK (for example, OpenJDK):
 
-        # Ensure apt-get is up to date.
+        # Update the packages
         $ sudo apt-get update
 
-        # Install build tools.
-        $ sudo apt-get install build-essential
+        # Installs the latest OpenJDK (***Only required if you don't already have a working JDK***)
+        $ sudo apt-get install -y openjdk-7-jdk
 
-        # Install OpenJDK java.
-        $ sudo apt-get install openjdk-6-jdk
+If you are building from git repository, you will need to additionally install the following packages:
 
-        # Install devel python.
-        $ sudo apt-get install python-dev python-boto
+        # Only necessary if building from git repository
+        $ sudo apt-get install -y autoconf libtool
 
-        # Install devel libcurl
-        $ sudo apt-get install libcurl4-nss-dev
+The following are the necessary dependencies for `Mesos 0.22`:
 
-        # Install devel libsasl (***Only required for Mesos 0.14.0 or newer***).
-        $ sudo apt-get install libsasl2-dev
+        $ sudo apt-get -y install build-essential python-dev python-boto \
+            libcurl4-nss-dev libsasl2-dev \
+            maven libapr1-dev libsvn-dev
 
-        # Install Maven (***Only required for Mesos 0.18.1 or newer***).
-        $ sudo apt-get install maven
 
-        # Install devel libapr1 (***Only required for Mesos 0.21.0 or newer***)
-        $ sudo apt-get install libapr1-dev
+### Mac OSX (Yosemite)
 
-        # Install devel libsvn (***Only required for Mesos 0.21.0 or newer***)
-        $ sudo apt-get install libsvn-dev
+Before starting, you will need to install [XCode](https://developer.apple.com/xcode/) and
+the Command Line Tools via the AppStore.
 
--  If you are building from git repository, you will need to additionally install the following packages.
+Use [homebrew](http://brew.sh/) to install the additional dependencies:
 
-        # Install autotoconf and automake.
-        $ sudo apt-get install autoconf
+        # If you don't already have `brew` installed
+        $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+        # Install libraries
+        brew install autoconf automake libtool subversion maven
+
+You may (optionally) also need [Python 3](https://www.python.org/downloads) as it's not installed by default
+on OSX.
 
-        # Install libtool.
-        $ sudo apt-get install libtool
 
 ### CentOS 6.5
 
@@ -98,6 +99,9 @@ There are different ways you can get Mes
         $ ../configure
         $ make
 
+to speed up the build and reduce verbosity of the logs, you can append `-j=<number of cores> V=0`
+to `make`.
+
         # Run test suite.
         $ make check
 
@@ -128,4 +132,4 @@ There are different ways you can get Mes
         # Run Python framework (***Exits after successfully running some tasks.***).
         $ ./src/examples/python/test-framework 127.0.0.1:5050
 
-*NOTE: To build the example frameworks, make sure you build the test suite by doing `make check`.*
\ No newline at end of file
+*NOTE: To build the example frameworks, make sure you build the test suite by doing `make check`.*

Modified: mesos/site/source/documentation/latest/mesos-c++-style-guide.md
URL: http://svn.apache.org/viewvc/mesos/site/source/documentation/latest/mesos-c%2B%2B-style-guide.md?rev=1685322&r1=1685321&r2=1685322&view=diff
==============================================================================
--- mesos/site/source/documentation/latest/mesos-c++-style-guide.md (original)
+++ mesos/site/source/documentation/latest/mesos-c++-style-guide.md Sat Jun 13 20:31:48 2015
@@ -161,13 +161,7 @@ The goal is to make code more concise an
 * Will **not** be invalidated during the lifetime of the alias. Otherwise document this explicitly.
 
 ```
-hashmap<int, hashset<int>> index;
-
-struct T
-{
-  int number;
-  string name;
-};
+hashmap<string, hashset<int>> index;
 
 // 1: Ok.
 const hashset<int>& values = index[2];
@@ -178,9 +172,9 @@ for (auto iterator = index.begin(); iter
 }
 
 // 3: Ok.
-foreachpair (const int& key, hashset<int>& values, index) {}
+foreachpair (const string& key, const hashset<int>& values, index) {}
 foreachvalue (const hashset<int>& values, index) {}
-foreachkey (const int& key, index) {}
+foreachkey (const string& key, index) {}
 
 // 4: Avoid aliases in most circumstances as they can be dangerous.
 //    This is an example of a dangling alias!

Modified: mesos/site/source/documentation/latest/powered-by-mesos.md
URL: http://svn.apache.org/viewvc/mesos/site/source/documentation/latest/powered-by-mesos.md?rev=1685322&r1=1685321&r2=1685322&view=diff
==============================================================================
--- mesos/site/source/documentation/latest/powered-by-mesos.md (original)
+++ mesos/site/source/documentation/latest/powered-by-mesos.md Sat Jun 13 20:31:48 2015
@@ -25,6 +25,7 @@ layout: documentation
 * [Coursera](https://www.coursera.org)
 * [CRP-Gabriel Lippmann](http://www.crpgl.lu)
 * [Daemon](http://www.daemon.com.au)
+* [DataMan](http://www.dataman-inc.com)
 * [Devicescape](http://www.devicescape.com)
 * [DueDil](http://www.duedil.com)
 * [eBay](http://www.ebay.com)
@@ -68,6 +69,7 @@ layout: documentation
 * [The Factory](http://www.thefactory.com)
 * [Time Warner Cable](http://www.timewarnercable.com)
 * [Twitter](http://www.twitter.com)
+* [Uber](http://www.uber.com)
 * [UCSF](http://www.ucsf.edu)
 * [UC Berkeley](http://www.berkeley.edu)
 * [Uninett AS](http://www.uninett.no)