rethinkdb / docs

RethinkDB documentation
http://rethinkdb.com/docs
Apache License 2.0
117 stars 167 forks source link

Improve cluster management documentation #631

Open coffeemug opened 9 years ago

coffeemug commented 9 years ago

I think cluster management docs could get a lot better. For example, I couldn't find references to stats, server_status, and jobs tables in the doc articles. I think we should add an "Operation" section, and in that section have the following articles:

We're going to do a big doc reorg for 2.0, so putting this into the 2.0 milestone. I'll grab @chipotle and possibly a few more people next week and we'll come up with a new doc structure that we can viably ship by 2.0.

chipotle commented 9 years ago

Sounds good. There's actually a v1.16 branch of the www tree, by the way, that will add the tables to the sidebar index, at least -- so you'll be able to find those more easily shortly, at least. :)

chipotle commented 9 years ago

My last suggestion for documentation restructuring had these in "Administration". Perhaps we should move the "System tables" section from there into the ReQL section and add "Monitoring" and "Job control" to Administration instead, although I'm not sure doing that would give us a real benefit in clarity.

https://gist.github.com/c3a4daf1b7e25fb5b4cd.git

danielmewes commented 9 years ago

I personally would put the system tables under "Administration" rather than ReQL. But I haven't thought too deeply about it.

chipotle commented 9 years ago

I'm assigning this to @coffeemug just to get an outline done at some point for a "best practices" document. We can reassign it to another engineer, but I'd need some basic bullet points to expand it into an article.

coffeemug commented 9 years ago

Ack.

coffeemug commented 9 years ago

I'm currently helping a customer with this, and doing writeups for them on various ways of setting things up. I'm hoping to turn this into a writeup we could put into the docs.

lanjie121828 commented 4 years ago

hello, is Best practices done? @coffeemug