rethinkdb / rethinkdb/docs

Improve cluster management documentation

Open
#631 7 comments 0 reactions 1 assignee View on GitHub

@coffeemug is already working on this.

Since Jul 24, 2015.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.