Consider adding more docs on RethinkDB Proxy
Open
@chipotle is already working on this.
Since Aug 30, 2016.
doc
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
I feel like I've been asked about it a lot in the last month, and as far as I can tell we only talk about it as an aside in the changefeed docs. It might be worth adding a page that talks more about the subject (I'm not quite sure where it would go in our existing scheme).
We should probably mention:
- What a proxy node is.
- Why they exist.
- What the performance characteristics are, especially for changefeeds.
- How to start one and what the network config needs to look like (specifically the fact that it behaves like a normal RethinkDB node and thus other nodes in the cluster will try to connect to it).
- Once https://github.com/rethinkdb/rethinkdb/issues/5138 is resolved we should add docs on how to start a proxy node on system startup too.
@chipotle, any thoughts on whether this is worthwhile and where it should go?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.