Author: dlester
Date: Wed Sep 10 07:13:27 2014
New Revision: 1623920
URL: http://svn.apache.org/r1623920
Log:
Updates website docs to be in sync with latest docs on git.
Modified:
mesos/site/README.md
mesos/site/Rakefile
mesos/site/publish/documentation/latest/mesos-c++-style-guide/index.html
mesos/site/publish/documentation/latest/powered-by-mesos/index.html
mesos/site/publish/documentation/mesos-c++-style-guide/index.html
mesos/site/publish/documentation/powered-by-mesos/index.html
mesos/site/publish/sitemap.xml
mesos/site/source/documentation/latest/mesos-c++-style-guide.md
mesos/site/source/documentation/latest/powered-by-mesos.md
Modified: mesos/site/README.md
URL:
http://svn.apache.org/viewvc/mesos/site/README.md?rev=1623920&r1=1623919&r2=1623920&view=diff
==============================================================================
--- mesos/site/README.md (original)
+++ mesos/site/README.md Wed Sep 10 07:13:27 2014
@@ -12,19 +12,25 @@ within the publish folder will be the ac
## Generating the site
To generate the site one only needs to run `rake` after performing the setup
tasks mentioned above. This will download the latest Apache Mesos documentation
-and integrate it into the site and generate all other files within the sources
-folder.
+contained in the `docs` folder, integrate them into the site, and generate all
+other files within the source folder.
rake
-## Developement
+## Development
To live edit the site run `rake dev` and then open a browser window to
http://localhost:4567/ . Any change you make to the sources dir will
be shown on the local dev site immediately. Errors will be shown in the
console you launched `rake dev` within.
+## Publishing the Site
+The website uses svnpubsub. The publish folder contains the websites content
+and when committed to the svn repository it will be automatically deployed to
+the live site.
+
+
## Other available tasks
rake build # Build the website from source
@@ -32,4 +38,5 @@ console you launched `rake dev` within.
rake clobber # Remove any generated file
rake dev # Run the site in development mode
rake update_docs # Update the latest docs from the Apache
Mesos codebase
-
+ rake doxygen # Update doxygen from C++
source files
+ rake javadoc # Update javadocs from java
source files
\ No newline at end of file
Modified: mesos/site/Rakefile
URL:
http://svn.apache.org/viewvc/mesos/site/Rakefile?rev=1623920&r1=1623919&r2=1623920&view=diff
==============================================================================
--- mesos/site/Rakefile (original)
+++ mesos/site/Rakefile Wed Sep 10 07:13:27 2014
@@ -2,7 +2,7 @@ require 'rubygems'
require 'rake/clean'
require 'fileutils'
-task :default => [:update_docs, :javadoc, :build, :clean]
+task :default => [:update_docs, :build, :clean]
tmp_dir = File.join(File.dirname(__FILE__), "tmp")
mesos_dir = File.join(tmp_dir, "mesos")
Modified:
mesos/site/publish/documentation/latest/mesos-c++-style-guide/index.html
URL:
http://svn.apache.org/viewvc/mesos/site/publish/documentation/latest/mesos-c%2B%2B-style-guide/index.html?rev=1623920&r1=1623919&r2=1623920&view=diff
==============================================================================
--- mesos/site/publish/documentation/latest/mesos-c++-style-guide/index.html
(original)
+++ mesos/site/publish/documentation/latest/mesos-c++-style-guide/index.html
Wed Sep 10 07:13:27 2014
@@ -119,14 +119,15 @@
<h3>Constant Names</h3>
<ul>
-<li>We use lowerCamelCase for constant names (Google uses a <code>k</code>
followed by mixed case, e.g. <code>kDaysInAWeek</code>).</li>
+<li>We use <a
href="http://en.wikipedia.org/wiki/CamelCase#Variations_and_synonyms";>lowerCamelCase</a>
for constant names (Google uses a <code>k</code> followed by mixed case, e.g.
<code>kDaysInAWeek</code>).</li>
</ul>
<h3>Function Names</h3>
<ul>
-<li>We use lowerCamelCase for function names (Google uses mixed case for
regular functions; and their accessors and mutators match the name of the
variable).</li>
+<li>We use <a
href="http://en.wikipedia.org/wiki/CamelCase#Variations_and_synonyms";>lowerCamelCase</a>
for function names (Google uses mixed case for regular functions; and their
accessors and mutators match the name of the variable).</li>
+<li>Leave spaces around overloaded operators. e.g. <code>operator +
(...);</code> rather than <code>operator+(...);</code></li>
</ul>
@@ -142,11 +143,29 @@
<ul>
<li>End each sentence with a period.</li>
<li>At most 70 characters per line in comments.</li>
+<li>For trailing comments, leave one space.</li>
+</ul>
+
+
+<h2>Breaks</h2>
+
+<ul>
+<li>Break before braces on function, class, struct and union definitions.
(Google attaches braces to the surrounding context)</li>
</ul>
<h2>Indentation</h2>
+<h3>Class Format</h3>
+
+<ul>
+<li>Access modifiers are not indented (Google uses one space indentation).</li>
+<li>Constructor initializers are indented by 2 spaces (Google indents by
4).</li>
+</ul>
+
+
+<h3>Function Definition/Invocation</h3>
+
<ul>
<li>Newline when calling or defining a function: indent with 4 spaces.</li>
<li>We do not follow Google’s style of wrapping on the open parenthesis,
the general goal is to reduce visual “jaggedness” in the code.
Prefer (1), (4), (5), sometimes (3), never (2):</li>
@@ -185,6 +204,8 @@ allocator->resourcesRecovered(
</pre>
+<h3>Continuation</h3>
+
<ul>
<li>Newline for an assignment statement: indent with 2 spaces.</li>
</ul>
@@ -196,7 +217,7 @@ Try<Duration> failoverTimeout =
</pre>
-<h2>New Lines</h2>
+<h2>Empty Lines</h2>
<ul>
<li>1 blank line at the end of the file.</li>
Modified: mesos/site/publish/documentation/latest/powered-by-mesos/index.html
URL:
http://svn.apache.org/viewvc/mesos/site/publish/documentation/latest/powered-by-mesos/index.html?rev=1623920&r1=1623919&r2=1623920&view=diff
==============================================================================
--- mesos/site/publish/documentation/latest/powered-by-mesos/index.html
(original)
+++ mesos/site/publish/documentation/latest/powered-by-mesos/index.html Wed Sep
10 07:13:27 2014
@@ -130,6 +130,7 @@
<li><a href="https://www.hioscar.com/";>Oscar Insurance</a></li>
<li><a href="https://www.paypal.com";>PayPal</a></li>
<li><a href="http://www.pinkbike.com";>Pinkbike</a></li>
+<li><a href="http://www.qubitproducts.com";>Qubit</a></li>
<li><a href="http://www.sailthru.com";>Sailthru</a></li>
<li><a href="http://www.sharethrough.com";>Sharethrough</a></li>
<li><a href="http://www.sigmoidanalytics.com/";>Sigmoid Analytics</a></li>
Modified: mesos/site/publish/documentation/mesos-c++-style-guide/index.html
URL:
http://svn.apache.org/viewvc/mesos/site/publish/documentation/mesos-c%2B%2B-style-guide/index.html?rev=1623920&r1=1623919&r2=1623920&view=diff
==============================================================================
--- mesos/site/publish/documentation/mesos-c++-style-guide/index.html (original)
+++ mesos/site/publish/documentation/mesos-c++-style-guide/index.html Wed Sep
10 07:13:27 2014
@@ -119,14 +119,15 @@
<h3>Constant Names</h3>
<ul>
-<li>We use lowerCamelCase for constant names (Google uses a <code>k</code>
followed by mixed case, e.g. <code>kDaysInAWeek</code>).</li>
+<li>We use <a
href="http://en.wikipedia.org/wiki/CamelCase#Variations_and_synonyms";>lowerCamelCase</a>
for constant names (Google uses a <code>k</code> followed by mixed case, e.g.
<code>kDaysInAWeek</code>).</li>
</ul>
<h3>Function Names</h3>
<ul>
-<li>We use lowerCamelCase for function names (Google uses mixed case for
regular functions; and their accessors and mutators match the name of the
variable).</li>
+<li>We use <a
href="http://en.wikipedia.org/wiki/CamelCase#Variations_and_synonyms";>lowerCamelCase</a>
for function names (Google uses mixed case for regular functions; and their
accessors and mutators match the name of the variable).</li>
+<li>Leave spaces around overloaded operators. e.g. <code>operator +
(...);</code> rather than <code>operator+(...);</code></li>
</ul>
@@ -142,11 +143,29 @@
<ul>
<li>End each sentence with a period.</li>
<li>At most 70 characters per line in comments.</li>
+<li>For trailing comments, leave one space.</li>
+</ul>
+
+
+<h2>Breaks</h2>
+
+<ul>
+<li>Break before braces on function, class, struct and union definitions.
(Google attaches braces to the surrounding context)</li>
</ul>
<h2>Indentation</h2>
+<h3>Class Format</h3>
+
+<ul>
+<li>Access modifiers are not indented (Google uses one space indentation).</li>
+<li>Constructor initializers are indented by 2 spaces (Google indents by
4).</li>
+</ul>
+
+
+<h3>Function Definition/Invocation</h3>
+
<ul>
<li>Newline when calling or defining a function: indent with 4 spaces.</li>
<li>We do not follow Google’s style of wrapping on the open parenthesis,
the general goal is to reduce visual “jaggedness” in the code.
Prefer (1), (4), (5), sometimes (3), never (2):</li>
@@ -185,6 +204,8 @@ allocator->resourcesRecovered(
</pre>
+<h3>Continuation</h3>
+
<ul>
<li>Newline for an assignment statement: indent with 2 spaces.</li>
</ul>
@@ -196,7 +217,7 @@ Try<Duration> failoverTimeout =
</pre>
-<h2>New Lines</h2>
+<h2>Empty Lines</h2>
<ul>
<li>1 blank line at the end of the file.</li>
Modified: mesos/site/publish/documentation/powered-by-mesos/index.html
URL:
http://svn.apache.org/viewvc/mesos/site/publish/documentation/powered-by-mesos/index.html?rev=1623920&r1=1623919&r2=1623920&view=diff
==============================================================================
--- mesos/site/publish/documentation/powered-by-mesos/index.html (original)
+++ mesos/site/publish/documentation/powered-by-mesos/index.html Wed Sep 10
07:13:27 2014
@@ -130,6 +130,7 @@
<li><a href="https://www.hioscar.com/";>Oscar Insurance</a></li>
<li><a href="https://www.paypal.com";>PayPal</a></li>
<li><a href="http://www.pinkbike.com";>Pinkbike</a></li>
+<li><a href="http://www.qubitproducts.com";>Qubit</a></li>
<li><a href="http://www.sailthru.com";>Sailthru</a></li>
<li><a href="http://www.sharethrough.com";>Sharethrough</a></li>
<li><a href="http://www.sigmoidanalytics.com/";>Sigmoid Analytics</a></li>
