Add redirections

.github/workflows/docs-pages.yaml

@@ -27,6 +27,8 @@ jobs:
         run: make -C docs setupenv
       - name: Build docs
         run: make -C docs multiversion
+      - name: Build redirects
+        run: make -C docs redirects
       - name: Deploy docs to GitHub Pages
         run: ./docs/_utils/deploy.sh
         env:

CONTRIBUTING.md

@@ -19,4 +19,4 @@ The Scylla C++ source code uses the [Seastar coding style](https://github.com/sc
 
 Header files in Scylla must be self-contained, i.e., each can be included without having to include specific other headers first. To verify that your change did not break this property, run `ninja dev-headers`. If you added or removed header files, you must `touch configure.py` first - this will cause `configure.py` to be automatically re-run to generate a fresh list of header files.
 
-For more criteria on what reviewers consider good code, see the [review checklist](https://github.com/scylladb/scylla/blob/master/docs/contribute/review-checklist.md).
+For more criteria on what reviewers consider good code, see the [review checklist](https://github.com/scylladb/scylla/blob/master/docs/dev/review-checklist.md).

cache_flat_mutation_reader.hh

@@ -727,7 +727,7 @@ void cache_flat_mutation_reader::maybe_drop_last_entry() noexcept {
     // This prevents unnecessary dummy entries from accumulating in cache and slowing down scans.
     //
     // Eviction can happen only from oldest versions to preserve the continuity non-overlapping rule
-    // (See docs/design-notes/row_cache.md)
+    // (See docs/dev/row_cache.md)
     //
     if (_last_row
             && !_read_context.is_reversed() // FIXME

docs/Makefile

@@ -71,6 +71,13 @@ multiversion: setup
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
+.PHONY: redirects
+redirects: setup
+	$(POETRY) run redirects-cli fromfile --yaml-file ./_utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+
 # Preview commands
 .PHONY: preview
 preview: setup

docs/_utils/redirects.yaml

@@ -0,0 +1,128 @@
+# stable branch
+/stable/contribute/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/stable/contribute/CONTRIBUTING.html: https://github.com/scylladb/scylla/blob/master/docs/dev/CONTRIBUTING.md
+/stable/contribute/backport.html: https://github.com/scylladb/scylla/blob/master/docs/dev/backport.md
+/stable/contribute/maintainer.html: https://github.com/scylladb/scylla/blob/master/docs/dev/maintainer.md
+/stable/contribute/review-checklist.html: https://github.com/scylladb/scylla/blob/master/docs/dev/review-checklist.md
+/stable/design-notes/IDL.html: https://github.com/scylladb/scylla/blob/master/docs/dev/IDL.md
+/stable/design-notes/cdc.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cdc.md
+/stable/design-notes/compaction_controller.html: https://github.com/scylladb/scylla/blob/master/docs/dev/compaction_controller.md
+/stable/design-notes/cql-extensions.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql-extensions.md
+/stable/design-notes/cql-extensions-internal.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql-extensions-internal.md
+/stable/design-notes/cql3-type-mapping.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql3-type-mapping.md
+/stable/design-notes/hinted_handoff_design.html: https://github.com/scylladb/scylla/blob/master/docs/dev/hinted_handoff_design.md
+/stable/design-notes/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/stable/design-notes/isolation.html: https://github.com/scylladb/scylla/blob/master/docs/dev/isolation.md
+/stable/design-notes/lua-type-mapping.html: https://github.com/scylladb/scylla/blob/master/docs/dev/lua-type-mapping.md
+/stable/design-notes/metrics.html: https://github.com/scylladb/scylla/blob/master/docs/dev/metrics.md
+/stable/design-notes/migrating-from-users-to-roles.html: https://github.com/scylladb/scylla/blob/master/docs/dev/migrating-from-users-to-roles.md
+/stable/design-notes/paged-queries.html: https://github.com/scylladb/scylla/blob/master/docs/dev/paged-queries.md
+/stable/design-notes/protocol-extensions.html: https://github.com/scylladb/scylla/blob/master/docs/dev/protocol-extensions.md
+/stable/design-notes/protocols.html: https://github.com/scylladb/scylla/blob/master/docs/dev/protocols.md
+/stable/design-notes/redis.html: https://github.com/scylladb/scylla/blob/master/docs/dev/redis.md
+/stable/design-notes/repair_based_node_ops.html: https://github.com/scylladb/scylla/blob/master/docs/dev/repair_based_node_ops.md
+/stable/design-notes/reverse-reads.html: https://github.com/scylladb/scylla/blob/master/docs/dev/reverse-reads.md
+/stable/design-notes/row_cache.html: https://github.com/scylladb/scylla/blob/master/docs/dev/row_cache.md
+/stable/design-notes/row_level_repair.html: https://github.com/scylladb/scylla/blob/master/docs/dev/row_level_repair.md
+/stable/design-notes/secondary_index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/secondary_index.md
+/stable/design-notes/sstable-scylla-format.html: https://github.com/scylladb/scylla/blob/master/docs/dev/sstable-scylla-format.md
+/stable/design-notes/sstables-directory-structure.html: https://github.com/scylladb/scylla/blob/master/docs/dev/sstables-directory-structure.md
+/stable/design-notes/system_keyspace.html: https://github.com/scylladb/scylla/blob/master/docs/dev/system_keyspace.md
+/stable/design-notes/system_schema_keyspace.html: https://github.com/scylladb/scylla/blob/master/docs/dev/system_schema_keyspace.md
+/stable/design-notes/wasm.html: https://github.com/scylladb/scylla/blob/master/docs/dev/wasm.md
+/stable/guides/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/stable/guides/HACKING.html: https://github.com/scylladb/scylla/blob/master/HACKING.md
+/stable/guides/api_v2.html: https://github.com/scylladb/scylla/blob/master/docs/dev/api_v2.md
+/stable/guides/building.html: https://github.com/scylladb/scylla/blob/master/docs/dev/building.md
+/stable/guides/debugging.html: https://github.com/scylladb/scylla/blob/master/docs/dev/debugging.md
+/stable/guides/docker-hub.html: https://github.com/scylladb/scylla/blob/master/docs/dev/docker-hub.md
+/stable/guides/logging.html: https://github.com/scylladb/scylla/blob/master/docs/dev/logging.md
+/stable/guides/testing.html: https://github.com/scylladb/scylla/blob/master/docs/dev/testing.md
+/stable/guides/tracing.html: https://github.com/scylladb/scylla/blob/master/docs/dev/tracing.md
+/stable/service_levels.html: https://github.com/scylladb/scylla/blob/master/docs/dev/service_levels.md
+
+# 4.6 branch
+/branch-4.6/contribute/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/branch-4.6/contribute/CONTRIBUTING.html: https://github.com/scylladb/scylla/blob/master/docs/dev/CONTRIBUTING.md
+/branch-4.6/contribute/backport.html: https://github.com/scylladb/scylla/blob/master/docs/dev/backport.md
+/branch-4.6/contribute/maintainer.html: https://github.com/scylladb/scylla/blob/master/docs/dev/maintainer.md
+/branch-4.6/contribute/review-checklist.html: https://github.com/scylladb/scylla/blob/master/docs/dev/review-checklist.md
+/branch-4.6/design-notes/IDL.html: https://github.com/scylladb/scylla/blob/master/docs/dev/IDL.md
+/branch-4.6/design-notes/cdc.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cdc.md
+/branch-4.6/design-notes/compaction_controller.html: https://github.com/scylladb/scylla/blob/master/docs/dev/compaction_controller.md
+/branch-4.6/design-notes/cql-extensions.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql-extensions.md
+/branch-4.6/design-notes/cql-extensions-internal.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql-extensions-internal.md
+/branch-4.6/design-notes/cql3-type-mapping.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql3-type-mapping.md
+/branch-4.6/design-notes/hinted_handoff_design.html: https://github.com/scylladb/scylla/blob/master/docs/dev/hinted_handoff_design.md
+/branch-4.6/design-notes/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/branch-4.6/design-notes/isolation.html: https://github.com/scylladb/scylla/blob/master/docs/dev/isolation.md
+/branch-4.6/design-notes/lua-type-mapping.html: https://github.com/scylladb/scylla/blob/master/docs/dev/lua-type-mapping.md
+/branch-4.6/design-notes/metrics.html: https://github.com/scylladb/scylla/blob/master/docs/dev/metrics.md
+/branch-4.6/design-notes/migrating-from-users-to-roles.html: https://github.com/scylladb/scylla/blob/master/docs/dev/migrating-from-users-to-roles.md
+/branch-4.6/design-notes/paged-queries.html: https://github.com/scylladb/scylla/blob/master/docs/dev/paged-queries.md
+/branch-4.6/design-notes/protocol-extensions.html: https://github.com/scylladb/scylla/blob/master/docs/dev/protocol-extensions.md
+/branch-4.6/design-notes/protocols.html: https://github.com/scylladb/scylla/blob/master/docs/dev/protocols.md
+/branch-4.6/design-notes/redis.html: https://github.com/scylladb/scylla/blob/master/docs/dev/redis.md
+/branch-4.6/design-notes/repair_based_node_ops.html: https://github.com/scylladb/scylla/blob/master/docs/dev/repair_based_node_ops.md
+/branch-4.6/design-notes/reverse-reads.html: https://github.com/scylladb/scylla/blob/master/docs/dev/reverse-reads.md
+/branch-4.6/design-notes/row_cache.html: https://github.com/scylladb/scylla/blob/master/docs/dev/row_cache.md
+/branch-4.6/design-notes/row_level_repair.html: https://github.com/scylladb/scylla/blob/master/docs/dev/row_level_repair.md
+/branch-4.6/design-notes/secondary_index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/secondary_index.md
+/branch-4.6/design-notes/sstable-scylla-format.html: https://github.com/scylladb/scylla/blob/master/docs/dev/sstable-scylla-format.md
+/branch-4.6/design-notes/sstables-directory-structure.html: https://github.com/scylladb/scylla/blob/master/docs/dev/sstables-directory-structure.md
+/branch-4.6/design-notes/system_keyspace.html: https://github.com/scylladb/scylla/blob/master/docs/dev/system_keyspace.md
+/branch-4.6/design-notes/system_schema_keyspace.html: https://github.com/scylladb/scylla/blob/master/docs/dev/system_schema_keyspace.md
+/branch-4.6/design-notes/wasm.html: https://github.com/scylladb/scylla/blob/master/docs/dev/wasm.md
+/branch-4.6/guides/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/branch-4.6/guides/HACKING.html: https://github.com/scylladb/scylla/blob/master/HACKING.md
+/branch-4.6/guides/api_v2.html: https://github.com/scylladb/scylla/blob/master/docs/dev/api_v2.md
+/branch-4.6/guides/building.html: https://github.com/scylladb/scylla/blob/master/docs/dev/building.md
+/branch-4.6/guides/debugging.html: https://github.com/scylladb/scylla/blob/master/docs/dev/debugging.md
+/branch-4.6/guides/docker-hub.html: https://github.com/scylladb/scylla/blob/master/docs/dev/docker-hub.md
+/branch-4.6/guides/logging.html: https://github.com/scylladb/scylla/blob/master/docs/dev/logging.md
+/branch-4.6/guides/testing.html: https://github.com/scylladb/scylla/blob/master/docs/dev/testing.md
+/branch-4.6/guides/tracing.html: https://github.com/scylladb/scylla/blob/master/docs/dev/tracing.md
+/branch-4.6/service_levels.html: https://github.com/scylladb/scylla/blob/master/docs/dev/service_levels.md
+
+# 4.5 branch
+/branch-4.5/contribute/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/branch-4.5/contribute/CONTRIBUTING.html: https://github.com/scylladb/scylla/blob/master/docs/dev/CONTRIBUTING.md
+/branch-4.5/contribute/backport.html: https://github.com/scylladb/scylla/blob/master/docs/dev/backport.md
+/branch-4.5/contribute/maintainer.html: https://github.com/scylladb/scylla/blob/master/docs/dev/maintainer.md
+/branch-4.5/contribute/review-checklist.html: https://github.com/scylladb/scylla/blob/master/docs/dev/review-checklist.md
+/branch-4.5/design-notes/IDL.html: https://github.com/scylladb/scylla/blob/master/docs/dev/IDL.md
+/branch-4.5/design-notes/cdc.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cdc.md
+/branch-4.5/design-notes/compaction_controller.html: https://github.com/scylladb/scylla/blob/master/docs/dev/compaction_controller.md
+/branch-4.5/design-notes/cql-extensions.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql-extensions.md
+/branch-4.5/design-notes/cql-extensions-internal.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql-extensions-internal.md
+/branch-4.5/design-notes/cql3-type-mapping.html: https://github.com/scylladb/scylla/blob/master/docs/dev/cql3-type-mapping.md
+/branch-4.5/design-notes/hinted_handoff_design.html: https://github.com/scylladb/scylla/blob/master/docs/dev/hinted_handoff_design.md
+/branch-4.5/design-notes/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/branch-4.5/design-notes/isolation.html: https://github.com/scylladb/scylla/blob/master/docs/dev/isolation.md
+/branch-4.5/design-notes/lua-type-mapping.html: https://github.com/scylladb/scylla/blob/master/docs/dev/lua-type-mapping.md
+/branch-4.5/design-notes/metrics.html: https://github.com/scylladb/scylla/blob/master/docs/dev/metrics.md
+/branch-4.5/design-notes/migrating-from-users-to-roles.html: https://github.com/scylladb/scylla/blob/master/docs/dev/migrating-from-users-to-roles.md
+/branch-4.5/design-notes/paged-queries.html: https://github.com/scylladb/scylla/blob/master/docs/dev/paged-queries.md
+/branch-4.5/design-notes/protocol-extensions.html: https://github.com/scylladb/scylla/blob/master/docs/dev/protocol-extensions.md
+/branch-4.5/design-notes/protocols.html: https://github.com/scylladb/scylla/blob/master/docs/dev/protocols.md
+/branch-4.5/design-notes/redis.html: https://github.com/scylladb/scylla/blob/master/docs/dev/redis.md
+/branch-4.5/design-notes/repair_based_node_ops.html: https://github.com/scylladb/scylla/blob/master/docs/dev/repair_based_node_ops.md
+/branch-4.5/design-notes/reverse-reads.html: https://github.com/scylladb/scylla/blob/master/docs/dev/reverse-reads.md
+/branch-4.5/design-notes/row_cache.html: https://github.com/scylladb/scylla/blob/master/docs/dev/row_cache.md
+/branch-4.5/design-notes/row_level_repair.html: https://github.com/scylladb/scylla/blob/master/docs/dev/row_level_repair.md
+/branch-4.5/design-notes/secondary_index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/secondary_index.md
+/branch-4.5/design-notes/sstable-scylla-format.html: https://github.com/scylladb/scylla/blob/master/docs/dev/sstable-scylla-format.md
+/branch-4.5/design-notes/sstables-directory-structure.html: https://github.com/scylladb/scylla/blob/master/docs/dev/sstables-directory-structure.md
+/branch-4.5/design-notes/system_keyspace.html: https://github.com/scylladb/scylla/blob/master/docs/dev/system_keyspace.md
+/branch-4.5/design-notes/system_schema_keyspace.html: https://github.com/scylladb/scylla/blob/master/docs/dev/system_schema_keyspace.md
+/branch-4.5/design-notes/wasm.html: https://github.com/scylladb/scylla/blob/master/docs/dev/wasm.md
+/branch-4.5/guides/index.html: https://github.com/scylladb/scylla/blob/master/docs/dev/index.md
+/branch-4.5/guides/HACKING.html: https://github.com/scylladb/scylla/blob/master/HACKING.md
+/branch-4.5/guides/api_v2.html: https://github.com/scylladb/scylla/blob/master/docs/dev/api_v2.md
+/branch-4.5/guides/building.html: https://github.com/scylladb/scylla/blob/master/docs/dev/building.md
+/branch-4.5/guides/debugging.html: https://github.com/scylladb/scylla/blob/master/docs/dev/debugging.md
+/branch-4.5/guides/docker-hub.html: https://github.com/scylladb/scylla/blob/master/docs/dev/docker-hub.md
+/branch-4.5/guides/logging.html: https://github.com/scylladb/scylla/blob/master/docs/dev/logging.md
+/branch-4.5/guides/testing.html: https://github.com/scylladb/scylla/blob/master/docs/dev/testing.md
+/branch-4.5/guides/tracing.html: https://github.com/scylladb/scylla/blob/master/docs/dev/tracing.md
+/branch-4.5/service_levels.html: https://github.com/scylladb/scylla/blob/master/docs/dev/service_levels.md

docs/pyproject.toml

@@ -15,6 +15,7 @@ sphinx-autobuild = "2021.3.14"
 Sphinx = "4.3.2"
 sphinx-multiversion-scylla = "~0.2.10"
 sphinx-markdown-tables = "0.0.15"
+redirects_cli ="0.1.0"
 
 [build-system]
 requires = ["poetry>=0.12"]

mutation.hh

@@ -156,7 +156,7 @@ public:
     // * consume_in_reverse::legacy_half_reverse - consume rows and range
     //   tombstones in legacy reverse order[2].
     //
-    // For definition of [1] and [2] see docs/design-notes/reverse-reads.md.
+    // For definition of [1] and [2] see docs/dev/reverse-reads.md.
     //
     // The consume operation is pausable and resumable:
     // * To pause return stop_iteration::yes from one of the consume() methods;