You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by al...@apache.org on 2016/11/24 11:34:42 UTC

[3/3] mesos git commit: Updated the markdown style guide with headings capitalization.

Updated the markdown style guide with headings capitalization.

Review: https://reviews.apache.org/r/53614/


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/21cd2aab
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/21cd2aab
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/21cd2aab

Branch: refs/heads/master
Commit: 21cd2aabecb65c47c58082dee3e8c93b2d234525
Parents: 770527d
Author: Alexander Rukletsov <ru...@gmail.com>
Authored: Thu Nov 24 12:32:31 2016 +0100
Committer: Alexander Rukletsov <al...@apache.org>
Committed: Thu Nov 24 12:34:00 2016 +0100

----------------------------------------------------------------------
 docs/markdown-style-guide.md | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/21cd2aab/docs/markdown-style-guide.md
----------------------------------------------------------------------
diff --git a/docs/markdown-style-guide.md b/docs/markdown-style-guide.md
index 667d6df..77b96cb 100644
--- a/docs/markdown-style-guide.md
+++ b/docs/markdown-style-guide.md
@@ -11,19 +11,39 @@ User guides and non-code technical documentation are stored in markdown files in
 **NOTE:** As of right now this is work in progress and the existing documentation might not yet comply to this style.
 
 
-## What to document?
+## 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.
+## 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 `configuration.md`!
 
 
+## Section Headings
+
+Use [title case](https://en.wikipedia.org/wiki/Capitalization#Title_case) for
+section headings, preferably the
+[APA style](http://blog.apastyle.org/apastyle/headings/) variant:
+
+* Capitalize the first word of any heading, including title, subtitle,
+  subheading.
+* Capitalize all "major" words (nouns, verbs, adjectives, adverbs, and pronouns)
+  in any heading, including the second part of hyphenated major words (e.g.,
+  Self-Report not Self-report).
+* Capitalize all words of five letters or more.
+
+Effectively, only "minor" words of four letters or fewer, namely, conjunctions
+(words like __and__, __or__, __nor__, and __but__), articles (the words __a__,
+__an__, and __the__), and prepositions (words like __as__, __at__, __by__,
+__for__, __from__, __in__, __of__, __on__, __per__, __to__, __with__), are
+lowercased in any heading, as long as they aren\u2019t the first word.
+
+
 ## Code Examples
 
 Code examples should be specified as follows:
@@ -37,6 +57,7 @@ Code examples should be specified as follows:
 
 **NOTE:** Because of shortcomings of Doxygen's markdown parser we currently use indentation for wrapping all non C++ code blocks.
 
+
 ## Notes/Emphasis
 
 Notes are used to highlight important parts of the text and should be specified as follows.
@@ -62,7 +83,7 @@ We use single backticks to highlight sample commands as follows:
 ~~~
 
 
-## Files/Path
+## Files/Paths
 
 Files and path references should be specified as follows: