70d914ad5b
The instructions in docs/alternator/getting-started.md on how to run Alternator with docker are outdated and confusing, so this patch updates them. First, the instructions recommended the scylladb/scylla-nightly:alternator tag, but we only ever created this tag once, and never updated it. Since then, Alternator has been constantly improving, and we've caught up on a lot of features, and people who want to test or evaluate Alternator will most likely want to run the latest nightly build, with all the latest Alternator features. So we update the instructions to request the latest nightly build - and mention the need to explictly do "docker pull" (without this step, you can find yourself running an antique nightly build, which you downloaded months ago!). This instruction can be revisited once Alternator is GAed and not improving quickly and we can then recommend to run the latest stable Scylla - but I think we're not there yet. Second, in recent builds, Alternator requires that the LWT feature is enabled, and since LWT is still experimental, this means that one needs to add "--experimental 1" to the "docker run" command. Without it, the command line in getting-started.md will refuse to boot, complaining that Alternator was enabled but LWT wasn't. So this patch adds the "--experimental 1" in the relevant places in the text. Again, this instruction can and should be revisited once LWT goes out of experimental mode. Fixes #5813 Signed-off-by: Nadav Har'El <nyh@scylladb.com> Message-Id: <20200216113601.9535-1-nyh@scylladb.com>
Scylla developer documentation
This folder (and its subfolders) contain developer-oriented documentation concerning the Scylla codebase. We also have a wiki, which contains additional developer-oriented documentation. There is currently no clear definition of what goes where, so when looking for something be sure to check both.
Seastar documentation can be found here.
User documentation can be found on docs.scylladb.com
For information on how to build Scylla and how to contribute visit HACKING.md and CONTRIBUTING.md.