c8348bccc9
This patch adds a new document, docs/protocols.md, about all the different protocols which Scylla supports - and the different ports which they use. This includes Scylla's internal protocol, user-facing protocols (CQL, Thrift, DynamoDB, Redis, JMX) and things inbetween (REST API, Prometheus). I wrote this document after being frustrated that when I see a port number (e.g., "7000") or a port option name (e.g., "storage_port") it's hard to figure out what they actually are - or why they are given such strange names. The intention is that this file can easily be searched for option names, for more familiar names (e.g., "CQL"), and a reader can get the whole story - including some pointers to relevant part of the code (this part of the document can be improved further - in this version this only exists for the internal protocol). Signed-off-by: Nadav Har'El <nyh@scylladb.com> Message-Id: <20200217172049.25510-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.