docs
docs copied to clipboard
rethinkdb
Improve cluster management documentation
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:
- Cluster configuration
- Sharding and replication
- Monitoring (which would contain info about status tables and stats)
- Job control
- Best practices
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.
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. :)
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
I personally would put the system tables under "Administration" rather than ReQL. But I haven't thought too deeply about it.
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.
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.
