couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [24/26] documentation commit: updated refs/heads/master to 5a81ace
Date Fri, 20 Feb 2015 00:26:57 GMT
The documentation now have a style

The documentation was put together from different sources, written by
different people. Then it was edited by even more people. And the result
was... interesting.

The time when you turned to the documentation, seeking answers to deep
questions like "How many ways are there to make a note-box?" is no more.


Project: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/commit/8d3e69e8
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/8d3e69e8
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/8d3e69e8

Branch: refs/heads/master
Commit: 8d3e69e89d1ae7530052a3c60b7499bebac74f0d
Parents: 6b84c18
Author: Maria Andersson <maria@dualpose.com>
Authored: Fri Feb 6 22:52:33 2015 +0100
Committer: Maria Andersson <maria@dualpose.com>
Committed: Fri Feb 6 22:52:33 2015 +0100

----------------------------------------------------------------------
 src/contributing.rst | 62 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/8d3e69e8/src/contributing.rst
----------------------------------------------------------------------
diff --git a/src/contributing.rst b/src/contributing.rst
index d8664f7..ca8ba9f 100644
--- a/src/contributing.rst
+++ b/src/contributing.rst
@@ -166,3 +166,65 @@ the "Pull Request" button. Fill in the description with something useful
and
 hit the "Send Pull Request" button.
 
 And we're done!
+
+Style Guidelines for this Documentation
+=======================================
+
+When you make a change to the documentation, you should make sure that you
+follow the style. Look through some files and you will see that the style is
+quite straightforward. If you do not know if your formating is in compliance
+with the style, ask yourself the following question::
+
+    Is it needed for correct syntax?
+
+If the answer is ``No.`` then it is probably not.
+
+These guidelines strive be simple, without contradictions and exceptions. The
+best style is the one that is followed because it seems to be the natural way of
+doing it.
+
+The guidelines
+--------------
+
+The guidelines are in descending priority.
+
+#. Syntax
+
+   * Correct syntax is always more important than style. This includes
+     configuration files, HTML responses, etc.
+
+#. Encoding
+
+   * All files are ``UTF-8``.
+
+#. Line ending
+
+   * All lines end with ``\n``.
+   * No trailing whitespaces.
+
+#. Line length
+
+   * The maximum line length is 80 characters.
+
+#. Links
+
+   * All internal links are relative.
+
+#. Indentation
+
+   * 4 spaces
+
+#. Titles
+
+   * The highest level titles in a file is over and underlined with =
+   * Lower level titles are underlined with the following characters in descending
+     order::
+
+        = - ^ *  + # ` : . " ~ _
+
+   * Over and underline match the title length.
+
+#. Empty lines
+
+   * No empty line at the end of the file.
+   * Lists may separated each item with an empty line.


Mime
View raw message