You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by bm...@apache.org on 2014/10/10 21:20:35 UTC
svn commit: r1630961 [1/3] - in /mesos/site: ./ publish/
publish/documentation/committers-guide/ publish/documentation/configuration/
publish/documentation/latest/committers-guide/
publish/documentation/latest/configuration/ source/documentation/latest/
Author: bmahler
Date: Fri Oct 10 19:20:34 2014
New Revision: 1630961
URL: http://svn.apache.org/r1630961
Log:
Added the committer's guide to the website.
Modified:
mesos/site/README.md
mesos/site/publish/documentation/committers-guide/index.html
mesos/site/publish/documentation/configuration/index.html
mesos/site/publish/documentation/latest/committers-guide/index.html
mesos/site/publish/documentation/latest/configuration/index.html
mesos/site/publish/sitemap.xml
mesos/site/source/documentation/latest/committers-guide.md
mesos/site/source/documentation/latest/configuration.md
Modified: mesos/site/README.md
URL: http://svn.apache.org/viewvc/mesos/site/README.md?rev=1630961&r1=1630960&r2=1630961&view=diff
==============================================================================
--- mesos/site/README.md (original)
+++ mesos/site/README.md Fri Oct 10 19:20:34 2014
@@ -39,4 +39,4 @@ the live site.
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
+ rake javadoc # Update javadocs from java source files
Modified: mesos/site/publish/documentation/committers-guide/index.html
URL: http://svn.apache.org/viewvc/mesos/site/publish/documentation/committers-guide/index.html?rev=1630961&r1=1630960&r2=1630961&view=diff
==============================================================================
--- mesos/site/publish/documentation/committers-guide/index.html (original)
+++ mesos/site/publish/documentation/committers-guide/index.html Fri Oct 10 19:20:34 2014
@@ -103,7 +103,7 @@
<p>See our <a href="/community/">community</a> page for more details.</p>
</div>
<div class="col-md-8">
- <p>Committer’s Guide</p>
+ <h1>Committer’s Guide</h1>
<p>This is an attempt to capture the “etiquette” that we’ve informally
used with Review Board and committing. A lot of this is obvious and
@@ -112,7 +112,7 @@ comprehensive and pedantic.</p>
<hr />
-<p>(1) Wait for a ‘ship it’. We often use the original developer or
+<p><strong>(1)</strong> <strong>Wait for a ‘ship it’</strong>. We often use the original developer or
current “custodian” of some particular code to be the reviewer and add
others to get more feedback or as an FYI. Feel free to explicitly call
out that you’re adding some people just as an FYI in the
@@ -121,7 +121,7 @@ to one another about a particular change
coding. A little context goes a long way to streamlining the review
process.</p>
-<p>(2) Resolve issues before committing. We tend to give a ‘ship it’ even
+<p><strong>(2)</strong> <strong>Resolve issues before committing</strong>. We tend to give a ‘ship it’ even
when we think there are some issues that need correcting. Sometimes a
particular issue will require more discussion and sometimes we take
that discussion to IM or IRC or emails to expedite the process. It’s
@@ -130,22 +130,22 @@ collaborations/discussions that happened
discussion public also helps involve others that would have liked to
get involved but weren’t invited.</p>
-<p>If the reviewer and reviewee are having problems resolving a
+<p><strong>(2.1)</strong> If the reviewer and reviewee are having problems resolving a
particular “confrontational” issue then both parties should consider
asking another reviewer to participate. We’re all here to build the
highest quality code possible, and we should leverage one another to
do so.</p>
-<p>(2.1) When an issue is “Dropped” by the reviewee, the expectation is
+<p><strong>(2.2)</strong> When an issue is “Dropped” by the reviewee, the expectation is
that there is a reply to the issue indicating why it was dropped. A
silent “Drop” is very ambiguous.</p>
-<p>(2.2) If an issue is marked as “Resolved”, the expectation is that the
+<p><strong>(2.3)</strong> If an issue is marked as “Resolved”, the expectation is that the
diff has been updated in accordance (more or less) with the reviewer’s
comment. If there are significant changes, a reply to the issue with a
comment is greatly appreciated.</p>
-<p>(3) Be patient, thoughtful, and respectful when providing (a) feedback
+<p><strong>(3)</strong> <strong>Be patient, thoughtful, and respectful</strong> when providing (a) feedback
on reviews and (b) commenting on feedback. This is not meant to be a
sparring match. A prerequisite to being a good reviewee is
acknowledging that ‘writing is hard’! The reviewee should give the
@@ -159,13 +159,13 @@ for giving hasty feedback. The reviewer
trying to explain their concerns clearly and carefully. It’s a two-way
street!</p>
-<p>(4) Be explicit about asking for more feedback. Feel free to update
+<p><strong>(4)</strong> <strong>Be explicit about asking for more feedback.</strong> Feel free to update
reviews as often as you like but recognize that in many cases it’s
ambiguous for reviewers when a review is back into a “ready” state so
the reviewee should feel free to ping the reviewers via email when
they’re ready.</p>
-<p>(5) Follow the format of commit messages. The three important bits are
+<p><strong>(5)</strong> <strong>Follow the format of commit messages.</strong> The three important bits are
(a) be clear and explicit in the commit message and (b) include the
link to the review and © use 72 character columns. See
support/apply-review.sh for committing someone else’s code (it will
@@ -175,10 +175,10 @@ which can be omitted). Note that we don&
or less summary because that restriction tends to cause people to
write poorly.</p>
-<p>(6) Never ever commit a merge. Rebase as appropriate. Likewise, never
+<p><strong>(6)</strong> <strong>Never ever commit a merge.</strong> Rebase as appropriate. Likewise, never
‘force push’.</p>
-<p>(7) Don’t break the build. People use Linux and Mac OS X, be
+<p><strong>(7)</strong> <strong>Don’t break the build.</strong> People use Linux and Mac OS X, be
thoughtful about doing a ‘make check’ on both before committing your
code. In the future we hope to have Jenkins running builds of our
reviews as well as our commits and not allowing code to be committed
Modified: mesos/site/publish/documentation/configuration/index.html
URL: http://svn.apache.org/viewvc/mesos/site/publish/documentation/configuration/index.html?rev=1630961&r1=1630960&r2=1630961&view=diff
==============================================================================
--- mesos/site/publish/documentation/configuration/index.html (original)
+++ mesos/site/publish/documentation/configuration/index.html Fri Oct 10 19:20:34 2014
@@ -179,7 +179,7 @@
between a given user's frameworks. Options
are the same as for user_allocator. (default: drf)
--hostname=VALUE The hostname the master should advertise in ZooKeeper.
- If left unset, system hostname will be used (recommended).
+ If left unset, the hostname is resolved from the IP address that the master binds to.
--[no-]log_auto_initialize Whether to automatically initialize the replicated log used for the
registry. If this is set to false, the log has to be manually
initialized when used for the very first time. (default: true)
@@ -314,7 +314,7 @@
environment or find hadoop on PATH) (default: )
--hostname=VALUE The hostname the slave should report.
- If left unset, system hostname will be used (recommended).
+ If left unset, the hostname is resolved from the IP address that the slave binds to.
--isolation=VALUE Isolation mechanisms to use, e.g., 'posix/cpu,posix/mem'
or 'cgroups/cpu,cgroups/mem' or 'external'. (default: posix/cpu,posix/mem)
Modified: mesos/site/publish/documentation/latest/committers-guide/index.html
URL: http://svn.apache.org/viewvc/mesos/site/publish/documentation/latest/committers-guide/index.html?rev=1630961&r1=1630960&r2=1630961&view=diff
==============================================================================
--- mesos/site/publish/documentation/latest/committers-guide/index.html (original)
+++ mesos/site/publish/documentation/latest/committers-guide/index.html Fri Oct 10 19:20:34 2014
@@ -103,7 +103,7 @@
<p>See our <a href="/community/">community</a> page for more details.</p>
</div>
<div class="col-md-8">
- <p>Committer’s Guide</p>
+ <h1>Committer’s Guide</h1>
<p>This is an attempt to capture the “etiquette” that we’ve informally
used with Review Board and committing. A lot of this is obvious and
@@ -112,7 +112,7 @@ comprehensive and pedantic.</p>
<hr />
-<p>(1) Wait for a ‘ship it’. We often use the original developer or
+<p><strong>(1)</strong> <strong>Wait for a ‘ship it’</strong>. We often use the original developer or
current “custodian” of some particular code to be the reviewer and add
others to get more feedback or as an FYI. Feel free to explicitly call
out that you’re adding some people just as an FYI in the
@@ -121,7 +121,7 @@ to one another about a particular change
coding. A little context goes a long way to streamlining the review
process.</p>
-<p>(2) Resolve issues before committing. We tend to give a ‘ship it’ even
+<p><strong>(2)</strong> <strong>Resolve issues before committing</strong>. We tend to give a ‘ship it’ even
when we think there are some issues that need correcting. Sometimes a
particular issue will require more discussion and sometimes we take
that discussion to IM or IRC or emails to expedite the process. It’s
@@ -130,22 +130,22 @@ collaborations/discussions that happened
discussion public also helps involve others that would have liked to
get involved but weren’t invited.</p>
-<p>If the reviewer and reviewee are having problems resolving a
+<p><strong>(2.1)</strong> If the reviewer and reviewee are having problems resolving a
particular “confrontational” issue then both parties should consider
asking another reviewer to participate. We’re all here to build the
highest quality code possible, and we should leverage one another to
do so.</p>
-<p>(2.1) When an issue is “Dropped” by the reviewee, the expectation is
+<p><strong>(2.2)</strong> When an issue is “Dropped” by the reviewee, the expectation is
that there is a reply to the issue indicating why it was dropped. A
silent “Drop” is very ambiguous.</p>
-<p>(2.2) If an issue is marked as “Resolved”, the expectation is that the
+<p><strong>(2.3)</strong> If an issue is marked as “Resolved”, the expectation is that the
diff has been updated in accordance (more or less) with the reviewer’s
comment. If there are significant changes, a reply to the issue with a
comment is greatly appreciated.</p>
-<p>(3) Be patient, thoughtful, and respectful when providing (a) feedback
+<p><strong>(3)</strong> <strong>Be patient, thoughtful, and respectful</strong> when providing (a) feedback
on reviews and (b) commenting on feedback. This is not meant to be a
sparring match. A prerequisite to being a good reviewee is
acknowledging that ‘writing is hard’! The reviewee should give the
@@ -159,13 +159,13 @@ for giving hasty feedback. The reviewer
trying to explain their concerns clearly and carefully. It’s a two-way
street!</p>
-<p>(4) Be explicit about asking for more feedback. Feel free to update
+<p><strong>(4)</strong> <strong>Be explicit about asking for more feedback.</strong> Feel free to update
reviews as often as you like but recognize that in many cases it’s
ambiguous for reviewers when a review is back into a “ready” state so
the reviewee should feel free to ping the reviewers via email when
they’re ready.</p>
-<p>(5) Follow the format of commit messages. The three important bits are
+<p><strong>(5)</strong> <strong>Follow the format of commit messages.</strong> The three important bits are
(a) be clear and explicit in the commit message and (b) include the
link to the review and © use 72 character columns. See
support/apply-review.sh for committing someone else’s code (it will
@@ -175,10 +175,10 @@ which can be omitted). Note that we don&
or less summary because that restriction tends to cause people to
write poorly.</p>
-<p>(6) Never ever commit a merge. Rebase as appropriate. Likewise, never
+<p><strong>(6)</strong> <strong>Never ever commit a merge.</strong> Rebase as appropriate. Likewise, never
‘force push’.</p>
-<p>(7) Don’t break the build. People use Linux and Mac OS X, be
+<p><strong>(7)</strong> <strong>Don’t break the build.</strong> People use Linux and Mac OS X, be
thoughtful about doing a ‘make check’ on both before committing your
code. In the future we hope to have Jenkins running builds of our
reviews as well as our commits and not allowing code to be committed
Modified: mesos/site/publish/documentation/latest/configuration/index.html
URL: http://svn.apache.org/viewvc/mesos/site/publish/documentation/latest/configuration/index.html?rev=1630961&r1=1630960&r2=1630961&view=diff
==============================================================================
--- mesos/site/publish/documentation/latest/configuration/index.html (original)
+++ mesos/site/publish/documentation/latest/configuration/index.html Fri Oct 10 19:20:34 2014
@@ -179,7 +179,7 @@
between a given user's frameworks. Options
are the same as for user_allocator. (default: drf)
--hostname=VALUE The hostname the master should advertise in ZooKeeper.
- If left unset, system hostname will be used (recommended).
+ If left unset, the hostname is resolved from the IP address that the master binds to.
--[no-]log_auto_initialize Whether to automatically initialize the replicated log used for the
registry. If this is set to false, the log has to be manually
initialized when used for the very first time. (default: true)
@@ -314,7 +314,7 @@
environment or find hadoop on PATH) (default: )
--hostname=VALUE The hostname the slave should report.
- If left unset, system hostname will be used (recommended).
+ If left unset, the hostname is resolved from the IP address that the slave binds to.
--isolation=VALUE Isolation mechanisms to use, e.g., 'posix/cpu,posix/mem'
or 'cgroups/cpu,cgroups/mem' or 'external'. (default: posix/cpu,posix/mem)