Skip to content
This repository was archived by the owner on Oct 17, 2022. It is now read-only.

Improve CouchDB setup documentation, esp. for clustering#356

Merged
wohali merged 1 commit intomasterfrom
improve-setup-docs
Nov 20, 2018
Merged

Improve CouchDB setup documentation, esp. for clustering#356
wohali merged 1 commit intomasterfrom
improve-setup-docs

Conversation

@wohali
Copy link
Copy Markdown
Member

@wohali wohali commented Nov 19, 2018

Overview

Our cluster setup instructions were a mess. Not only that, they were missing two very critical points: consistent UUID and consistent http secret across all nodes in a cluster. (Our setup wizard doesn't currently ensure these, so they must be done manually.)

If you are reviewing this PR, note that src/setup/cluster.rst was not just moved to a new directory, but completely overhauled.

I'd like to get this in before 2.3.0 releases.

Testing recommendations

You could try setting up a new cluster using the information in src/setup/cluster.rst if you wanted.

GitHub issue number

Addresses numerous requests that have come in through IRC/Slack, but no specific GH issue.

Checklist

  • Documentation is written and is accurate;
  • make check passes with no errors
  • Update rebar.config.script with the commit hash once this PR is rebased and merged

@wohali wohali requested review from flimzy and janl November 19, 2018 22:27
@janl
Copy link
Copy Markdown
Member

janl commented Nov 20, 2018

slight preference to have the wizard and api come before the manual setup, but great work overall. +1

@wohali
Copy link
Copy Markdown
Member Author

wohali commented Nov 20, 2018

@janl It is, the setup wizard doesn't do enough, so manual steps are required before it can be used. The fully manual section is still at the bottom.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants