[GitHub] [couchdb-documentation] thigg opened a new issue #656: DesignDocument section suggestions

[GitBox <gi...@apache.org>]

thigg opened a new issue #656:
URL: https://github.com/apache/couchdb-documentation/issues/656


   I am currently trying to understand design documents and I tried to make some suggestions out of my recent experiences with the documentation.
   I still don't fully understand everything, but I hope a few things are a good idea.
   
   1. Most common use-cases first.  
     For example, "views" with map/reduce should be explained first, because most readers would look for that. Maybe they could even be simply shown in the overview and linked. But also the obsolete functions like `show` should be on a separate page. A new reader shouldn't have to scroll over them, as they are deprecated anyway.
   2.Extend the general section with a general overview over the functions. The in-depth details are good to look them up. But first f all you need to know whats possible.
   2. Have some examples with full design documents. As a new reader, you may want to try out the examples, but there is no single example on how the actual design documents look like. You find a single reference to the `views` field in the chapter about views, but I had to look somewhere else, that this is an object with subobjects for each view. The same goes for others like `mapfun`.
   3. Explain the difference between `mapfun` and `views/map`. Maybe this should be in a general section as well.
   4. Rereduce is only explained with `Rereduce is used for additional reduce values list`. A usecase would be nice here as well.
   
   
   As I said, I didn't understand everything yet, because of that, this is no PR. But if some parts seem like a good idea, I'd be happy to help.


-- 
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] wohali commented on issue #656: DesignDocument section suggestions

[GitBox <gi...@apache.org>]

wohali commented on issue #656:
URL: https://github.com/apache/couchdb-documentation/issues/656#issuecomment-885048116


   Step 0 is that users should try and use Mango first - which is significantly more performant than ddocs and far easier to understand.


-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org

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