You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by GitBox <gi...@apache.org> on 2021/03/26 16:16:54 UTC

[GitHub] [couchdb-documentation] tommikarkkainen opened a new pull request #631: Add description of a ddoc structure

tommikarkkainen opened a new pull request #631:
URL: https://github.com/apache/couchdb-documentation/pull/631


   <!-- Thank you for your contribution!
   
        Please file this form by replacing the Markdown comments
        with your text. If a section needs no action - remove it.
   
        Also remember, that CouchDB uses the Review-Then-Commit (RTC) model
        of code collaboration. Positive feedback is represented +1 from committers
        and negative is a -1. The -1 also means veto, and needs to be addressed
        to proceed. Once there are no objections, the PR can be merged by a
        CouchDB committer.
   
        See: http://couchdb.apache.org/bylaws.html#decisions for more info. -->
   
   ## Overview
   
   <!-- Please give a short brief for the pull request,
        what problem it solves or how it makes things better. -->
   
   Describes the structure of a design document in a newbie-friendly way.
   
   ## Testing recommendations
   
   <!-- Describe how we can test your changes.
        Does it provides any behaviour that the end users
        could notice? -->
   
   Please check that the example I added is correct. I've tested it to the best of my abilities but would like someone else to take a look at it too.
   
   ## GitHub issue number
   
   <!-- If this is a significant change, please file a separate issue at:
        https://github.com/apache/couchdb-documentation/issues
        and include the number here and in commit message(s) using
        syntax like "Fixes #472" or "Fixes apache/couchdb#472".  -->
   
   Related to #359 and #429 
   
   ## Related Pull Requests
   
   <!-- If your changes affects multiple components in different
        repositories please put links to those pull requests here.  -->
   
   ## Checklist
   
   - [ ] Update [rebar.config.script](https://github.com/apache/couchdb/blob/main/rebar.config.script) with the commit hash once this PR is rebased and merged
   <!-- Before opening the PR, consider running `make check` locally for a faster turnaround time -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] nickva commented on a change in pull request #631: Add description of a ddoc structure

Posted by GitBox <gi...@apache.org>.
nickva commented on a change in pull request #631:
URL: https://github.com/apache/couchdb-documentation/pull/631#discussion_r602450270



##########
File path: src/ddocs/ddocs.rst
##########
@@ -32,19 +32,47 @@ them extensively within each function:
 - :ref:`Database Security object <security_object>`
 - :ref:`Guide to JavaScript Query Server <query-server/js>`
 
-Creation
-========
+Creation and structure

Review comment:
       Minor nit: maybe use a capital `S` in `Structure` just for consistency with other titles. I don't actually remember the correct rule there but consistency would be better I think.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] nickva commented on pull request #631: Add description of a ddoc structure

Posted by GitBox <gi...@apache.org>.
nickva commented on pull request #631:
URL: https://github.com/apache/couchdb-documentation/pull/631#issuecomment-808396041


   @tommikarkkainen I merged the PR. Thank you again for your contribution!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] tommikarkkainen commented on a change in pull request #631: Add description of a ddoc structure

Posted by GitBox <gi...@apache.org>.
tommikarkkainen commented on a change in pull request #631:
URL: https://github.com/apache/couchdb-documentation/pull/631#discussion_r602466583



##########
File path: src/ddocs/ddocs.rst
##########
@@ -32,19 +32,47 @@ them extensively within each function:
 - :ref:`Database Security object <security_object>`
 - :ref:`Guide to JavaScript Query Server <query-server/js>`
 
-Creation
-========
+Creation and structure

Review comment:
       Well spotted! I just pushed the fix. Thank you.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] nickva merged pull request #631: Add description of a ddoc structure

Posted by GitBox <gi...@apache.org>.
nickva merged pull request #631:
URL: https://github.com/apache/couchdb-documentation/pull/631


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org