Files

Andrei Chekun b6aabca9a7 Add documentation how to use allure reporting

Add documentation how to install and basic usage example of the allure reporting tool.
Fix typo test/README.md

Related: scylladb/qa-tasks#1665

Depends on: scylladb/scylladb#18169

Closes scylladb/scylladb#18710

2024-07-01 16:21:50 +02:00

api_v2.md

docs: dev: correct a typo

2023-03-31 17:19:08 +03:00

backport.md

Typos: fix typos in documentation

2023-12-07 11:10:17 +02:00

building.md

Merge 'Fixes for docs/dev/building.md' from Kamil Braun

2023-02-26 19:27:33 +02:00

cdc.md

raft topology: store committed CDC generations' IDs in the topology

2024-02-20 12:35:16 +01:00

code-coverage.md

Add code coverage documentation

2024-01-18 11:11:34 +02:00

commitlog-file-format.md

docs: Add docs on commitlog format 3

2023-11-21 08:50:57 +00:00

compaction_controller.md

docs: dev: write mathematical expressions in LaTeX

2023-03-29 15:07:14 +03:00

compilation-time-analysis.md

doc/dev: add document about analyzing build time

2023-09-01 11:33:36 +03:00

cql3-type-mapping.md

…

cql-extensions-internal.md

…

debugging.md

Typos: more/less then -> more/less than

2024-02-13 17:16:15 +02:00

docker-hub.md

treewide: drop thrift support

2024-06-07 06:44:59 +08:00

hinted_handoff_design.md

docs: Update Hinted Handoff documentation

2024-04-28 01:22:59 +02:00

IDL.md

Typos: more/less then -> more/less than

2024-02-13 17:16:15 +02:00

isolation.md

docs: isolation.md: add section on RPC call isolation

2024-05-21 03:12:22 -04:00

logging.md

…

lua-type-mapping.md

…

maintainer.md

docs: fix typos in dev documents

2024-05-27 12:28:34 +03:00

metrics.md

…

migrating-from-users-to-roles.md

…

modules.md

docs: add a rough diagram of module interaction

2024-01-23 18:08:48 +02:00

mvcc.md

doc: Introduce docs/dev/mvcc.md

2023-01-27 19:15:39 +01:00

object_storage.md

docs/dev/object_stroage.md: convert example AWS keys to be more innocent

2024-05-09 08:26:43 +03:00

paged-queries.md

treewide: rename flat_mutation_reader_v2 to mutation_reader

2024-06-21 07:12:06 +03:00

parallel_aggregations.md

…

per-partition-rate-limit.md

Typos: fix typos in documentation

2023-12-07 11:10:17 +02:00

protocol-extensions.md

docs: fix misspellings

2024-01-26 13:14:21 +02:00

protocols.md

treewide: drop thrift support

2024-06-07 06:44:59 +08:00

raft-in-scylla.md

Merge 'Don't calculate hashes for schema versions in Raft mode' from Kamil Braun

2023-12-11 12:17:57 +01:00

reader-concurrency-semaphore.md

Typos: fix typos in documentation

2023-12-07 11:10:17 +02:00

README.md

docs: fix misspellings

2024-01-26 13:14:21 +02:00

redis.md

docs: fix typos in dev documents

2024-05-27 12:28:34 +03:00

repair_based_node_ops.md

docs/dev/repair_based_node_ops: better formatting

2023-05-25 08:31:43 +03:00

reverse-reads.md

mutation{,_consumer,_partition}: remove consume_in_reverse::legacy_half_reverse

2023-01-05 18:48:55 +01:00

review-checklist.md

…

row_cache.md

doc: Introduce docs/dev/mvcc.md

2023-01-27 19:15:39 +01:00

row_level_repair.md

…

rust.md

rust: use depfile and Cargo.lock to avoid building rust when unnecessary

2023-01-12 14:44:11 +02:00

secondary_index.md

docs/design-notes/secondary_index: add VALUES to index target list

2022-08-14 10:29:52 +03:00

service_levels.md

db: auth: move auth tables to system keyspace

2024-05-26 22:30:42 +03:00

sstable-scylla-format.md

sstables: mx/writer: add large_data_type::elements_in_collection

2022-10-04 08:41:56 +03:00

sstables-directory-structure.md

…

system_keyspace.md

treewide: drop thrift support

2024-06-07 06:44:59 +08:00

system_schema_keyspace.md

…

task_manager.md

docs: describe task folding

2024-05-31 10:40:04 +02:00

testing.md

Add documentation how to use allure reporting

2024-07-01 16:21:50 +02:00

timestamp-conflict-resolution.md

docs: use less slangy language

2024-03-13 13:33:37 +02:00

topology-over-raft.md

Extend system.topology with 3 new columns to store data required to process alter ks global topo req

2024-05-28 13:55:11 +02:00

tracing.md

…

virtual-tables.md

…

README.md

Scylla developer documentation

This folder contains developer-oriented documentation concerning the ScyllaDB 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.

Index

Module list and dependencies