couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject git commit: updated refs/heads/master to b6bf3ec
Date Sun, 19 May 2013 16:27:15 GMT
Updated Branches:
  refs/heads/master 947d116b3 -> b6bf3ecec


docs: clean up the contributing guide a little


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

Branch: refs/heads/master
Commit: b6bf3ecec46c7f181ef35652365398ee77c7882d
Parents: 947d116
Author: Dirkjan Ochtman <djc@apache.org>
Authored: Sun May 19 18:25:35 2013 +0200
Committer: Dirkjan Ochtman <djc@apache.org>
Committed: Sun May 19 18:25:35 2013 +0200

----------------------------------------------------------------------
 share/doc/src/contributing.rst |   14 ++++++--------
 1 files changed, 6 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/b6bf3ece/share/doc/src/contributing.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/contributing.rst b/share/doc/src/contributing.rst
index 48a6da9..edc20d5 100644
--- a/share/doc/src/contributing.rst
+++ b/share/doc/src/contributing.rst
@@ -29,7 +29,7 @@ right. This will create a fork of CouchDB in your GitHub account. Mine is
 `janl`, so my fork lives at https://github.com/janl/couchdb. In the header, it
 tells me me my "GitHub Clone URL". We need to copy that and start a terminal:
 
-.. code-block: shell
+.. code-block:: bash
 
     $ git clone https://github.com/janl/couchdb.git
     $ cd couchdb
@@ -38,7 +38,7 @@ tells me me my "GitHub Clone URL". We need to copy that and start a terminal:
 I'm opening the whole CouchDB source tree in my favourite editor. It gives
 me the usual directory listing:
 
-.. code-block: shell
+.. code-block:: bash
 
     .git/
     .gitignore
@@ -70,8 +70,8 @@ me the usual directory listing:
     utils/
     var/
 
-The documentation sources live in `src/doc`, you can safely ignore all the
-other files and directories.
+The documentation sources live in `share/doc/src`, you can safely ignore all
+the other files and directories.
 
 First we should determine where we want to document this inside the
 documentation. We can look through http://docs.couchdb.org/en/latest/
@@ -88,7 +88,7 @@ but we'll leave this for later.
 
 Let's try and find the source file that builds the file
 http://docs.couchdb.org/en/latest/json-structure.html -- we are in luck, under
-`share/docs/src/` we find the file `json-structure.rst`. That looks promising.
+`share/doc/src` we find the file `json-structure.rst`. That looks promising.
 `.rst` stands for ReStructured Text (see
 http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
 for a markup reference), which is an ascii format for writing
@@ -161,9 +161,7 @@ Then we push the commit to our CouchDB fork::
     $ git push origin master
 
 Next, we go back to our GitHub page https://github.com/janl/couchdb and click
-the “Pull Request button”. Fill in the description with something useful and
+the "Pull Request" button. Fill in the description with something useful and
 hit the "Send Pull Request" button.
 
 And we're done!
-
-


Mime
View raw message