6e7cab5b45
This change adds an md file which gives a high level overview of the scylladb repository, the components each path contains and a basic description for each one of them. This is mainly intended for onboarding engineers to help get a mental picture when starting ramping up on Scylla concepts. Refs #22908 Signed-off-by: Robert Bindar <robert.bindar@scylladb.com> Closes scylladb/scylladb#23010
23 lines
804 B
Markdown
23 lines
804 B
Markdown
# Scylla developer documentation
|
|
|
|
This folder contains developer-oriented documentation
|
|
concerning the ScyllaDB codebase.
|
|
We also have a [wiki](https://github.com/scylladb/scylla/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](http://docs.seastar.io/master/index.html).
|
|
|
|
User documentation can be found on
|
|
[docs.scylladb.com](https://docs.scylladb.com/)
|
|
|
|
For information on how to build Scylla and how to contribute visit
|
|
[HACKING.md](../../HACKING.md) and [CONTRIBUTING.md](../../CONTRIBUTING.md).
|
|
|
|
Index
|
|
=====
|
|
[Module list and dependencies](modules.md)
|
|
|
|
[Repository layout and short summary of components](repository_layout.md)
|