You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by rn...@apache.org on 2019/04/23 10:07:50 UTC

[couchdb-documentation] branch master updated: Clarify how design documents are created

This is an automated email from the ASF dual-hosted git repository.

rnewson pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git


The following commit(s) were added to refs/heads/master by this push:
     new feb33ff  Clarify how design documents are created
feb33ff is described below

commit feb33ff5065619b7f636f48da08c5c0b3a8ecbf0
Author: Shaun Keys <sm...@gmail.com>
AuthorDate: Fri Apr 12 10:43:59 2019 -0600

    Clarify how design documents are created
---
 src/ddocs/ddocs.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/ddocs/ddocs.rst b/src/ddocs/ddocs.rst
index 345948a..1b3c9bd 100644
--- a/src/ddocs/ddocs.rst
+++ b/src/ddocs/ddocs.rst
@@ -32,6 +32,19 @@ them extensively within each function:
 - :ref:`Database Security object <security_object>`
 - :ref:`Guide to JavaScript Query Server <query-server/js>`
 
+Creation
+========
+
+Design documents are denoted by an id field with the format ``_design/{name}``.
+
+**Example**:
+
+.. code-block:: json
+
+    {
+        "id": "_design/example",
+    }
+
 .. _viewfun:
 
 View Functions