mirror of https://github.com/scylladb/scylladb.git synced 2026-06-04 05:53:13 +00:00

Files

Pekka Enberg e4266ead98 Improve build documentation

This improves the build documentation beyond just packaging:

- Explain how the configure.py step works

- Explain how to build just executables and tests (for development)

- Explain how to build for specific build mode if you didn't specify a
  build mode in configure.py step

- Fix build artifact locations, missing .debs, and add executables and
  tests

Message-Id: <20200904084443.495137-1-penberg@iki.fi>

2020-09-07 10:51:31 +03:00

alternator

docs: fix typo in alternator/getting-started.md

2020-08-27 14:11:00 +03:00

redis

redis: add hget and hset commands

2020-08-30 22:05:41 +03:00

api_v2.md

Explanation about the API V2

2018-03-28 12:42:04 +03:00

backport.md

Document backport queue and procedure (#5282 )

2019-11-17 01:45:24 -08:00

building.md

Improve build documentation

2020-09-07 10:51:31 +03:00

cdc.md

cdc: rename CDC description tables... again

2020-08-31 11:33:14 +03:00

coding-style.md

Merge "Misc documentation cleanup" from Botond

2019-10-15 12:53:49 +02:00

compaction_controller.md

document the compaction controller

2018-01-03 19:58:57 -05:00

cql-extensions.md

lwt: introduce paxos_grace_seconds per-table option to set paxos ttl

2020-08-17 16:44:14 +02:00

debugging.md

docs/debugging.md: document how TLS variables work

2020-09-03 17:41:15 +02:00

docker-hub.md

dist/docker: Add '--io-setup ENABLE' command line option

2020-07-21 14:42:46 +03:00

hinted_handoff_design.md

docs: hinted_handoff_design.md: high level design of a Hinted Handoff feature

2017-12-14 15:05:47 -05:00

IDL.md

Merge "Misc documentation cleanup" from Botond

2019-10-15 12:53:49 +02:00

in_memory_representation.md

imr: move documentation to docs/

2019-11-28 16:47:52 +02:00

isolation.md

docs/isolation.md: copy-edit

2019-10-10 15:17:28 +03:00

logging.md

docs/logging.md: improvements

2019-01-06 13:20:53 +02:00

lua-type-mapping.md

Lua: Document the conversions between Lua and CQL

2019-11-07 08:41:08 -08:00

maintainer.md

docs: correct typo in maintainers.md

2020-08-11 12:54:41 +03:00

metrics.md

docs/metrics.md: document additional "lables"

2019-09-09 15:15:57 +03:00

migrating-from-users-to-roles.md

auth: Migrate legacy data on boot

2018-02-14 14:15:59 -05:00

paged-queries.md

docs: add paged-queries.md design doc

2018-09-03 10:31:44 +03:00

protocol-extensions.md

docs: Improve protocol-extensions documentation

2020-09-06 13:35:12 +03:00

protocols.md

docs/protocol: Document CQL protocol port configuration options

2020-08-11 13:15:24 +03:00

README.md

docs: add README.md

2019-10-10 14:14:09 +03:00

repair_based_node_ops.md

docs: Add doc for repair_based_node_ops

2020-02-25 08:54:35 +08:00

review-checklist.md

Merge "Misc documentation cleanup" from Botond

2019-10-15 12:53:49 +02:00

row_cache.md

doc: Fix row_cache.md

2018-03-10 16:27:04 +02:00

row_level_repair.md

docs: Add RPC stream doc for row level repair

2019-07-03 08:09:57 +08:00

secondary_index.md

docs: document index target serialization

2019-03-20 09:51:46 +01:00

sstable-scylla-format.md

sstables: freeze types nested in collection types in legacy sstables

2020-04-16 18:44:56 +03:00

sstables-directory-structure.md

docs: add sstables-directory-structure.md

2019-02-22 11:08:22 +02:00

system_keyspace.md

Improve documentation on the system.large_* tables

2019-08-21 10:36:25 +03:00

system_schema_keyspace.md

docs: init system_schema_keyspace.md with column computations

2019-07-19 11:58:42 +02:00

testing.md

test.py: add a help file

2020-01-30 11:05:02 +02:00

tracing.md

docs: add paragraph to tracing.md

2020-07-27 13:38:57 +03:00

README.md

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.