svn commit: r1583024 - /thrift/cms-site/trunk/content/docs/committers/HowToThriftWebsite.md

[jo...@apache.org]

Author: joes
Date: Sat Mar 29 16:40:59 2014
New Revision: 1583024

URL: http://svn.apache.org/r1583024
Log:
advice

Modified:
    thrift/cms-site/trunk/content/docs/committers/HowToThriftWebsite.md

Modified: thrift/cms-site/trunk/content/docs/committers/HowToThriftWebsite.md
URL: http://svn.apache.org/viewvc/thrift/cms-site/trunk/content/docs/committers/HowToThriftWebsite.md?rev=1583024&r1=1583023&r2=1583024&view=diff
==============================================================================
--- thrift/cms-site/trunk/content/docs/committers/HowToThriftWebsite.md (original)
+++ thrift/cms-site/trunk/content/docs/committers/HowToThriftWebsite.md Sat Mar 29 16:40:59 2014
@@ -33,6 +33,17 @@ changes so it can automatically (and eff
 you were working locally with a daemon that watches your filesystem for modifications and
 builds them.
 
+Remember most of all that markdown is aimed first at foremost at human readers, so try to
+ensure your source content is easily understood by
+
+    - Keeping headings separated from other content with surrounding blank lines,
+    - Avoiding long lines of text, wrapping at 80-100 characters on average,
+    - Keeping embedded HTML separated from markdown content by blank lines,
+    - Preferring four-space indents per level over tab characters.
+
+Not only will your readers prefer a clean style, it will result in fewer bugs and a more 
+consistent experience with the various markdown parsers deployed by the CMS.
+
 ### Updating Release Versions
 
 The current release versioning is kept in the YAML __DATA__ section of the global "configuration