Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DesignDocument section suggestions #4224

Open
thigg opened this issue Apr 26, 2021 · 1 comment
Open

DesignDocument section suggestions #4224

thigg opened this issue Apr 26, 2021 · 1 comment

Comments

@thigg
Copy link

thigg commented Apr 26, 2021

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.
  3. 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.
  4. Explain the difference between mapfun and views/map. Maybe this should be in a general section as well.
  5. 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.

@wohali
Copy link
Member

wohali commented Jul 22, 2021

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

@big-r81 big-r81 transferred this issue from apache/couchdb-documentation Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants