From aa928461566895052ef97d220cc116233fd78cc5 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Tue, 20 Feb 2024 12:42:33 +0100 Subject: [PATCH] Refactoring: Rename `handbook` to `admin` again The label fits better to the content, and it actually has been the label used previously. --- docs/{handbook => admin}/bootstrap-checks.rst | 0 docs/{handbook => admin}/clustering/index.rst | 0 docs/{handbook => admin}/clustering/kubernetes.rst | 0 .../clustering/logical-replication-setup.rst | 0 .../clustering/multi-node-setup.rst | 0 .../clustering/multi-zone-setup.rst | 0 docs/{handbook => admin}/going-into-production.rst | 0 docs/{handbook => admin}/index.rst | 11 +++++------ docs/{handbook => admin}/performance/index.rst | 0 docs/{handbook => admin}/performance/inserts/bulk.rst | 0 .../{handbook => admin}/performance/inserts/index.rst | 0 .../performance/inserts/methods.rst | 0 .../performance/inserts/parallel.rst | 0 .../performance/inserts/testing.rst | 0 .../performance/inserts/tuning.rst | 0 docs/{handbook => admin}/performance/memory.rst | 0 docs/{handbook => admin}/performance/selects.rst | 0 docs/{handbook => admin}/performance/sharding.rst | 0 docs/{handbook => admin}/sharding-partitioning.rst | 0 .../troubleshooting/crate-node.rst | 0 .../troubleshooting/docker-jcmd.rst | 0 docs/{handbook => admin}/troubleshooting/index.rst | 0 .../{handbook => admin}/troubleshooting/systables.rst | 0 docs/{handbook => admin}/upgrade/full.rst | 0 docs/{handbook => admin}/upgrade/planning.rst | 0 docs/{handbook => admin}/upgrade/rolling.rst | 0 docs/index.md | 8 ++++---- 27 files changed, 9 insertions(+), 10 deletions(-) rename docs/{handbook => admin}/bootstrap-checks.rst (100%) rename docs/{handbook => admin}/clustering/index.rst (100%) rename docs/{handbook => admin}/clustering/kubernetes.rst (100%) rename docs/{handbook => admin}/clustering/logical-replication-setup.rst (100%) rename docs/{handbook => admin}/clustering/multi-node-setup.rst (100%) rename docs/{handbook => admin}/clustering/multi-zone-setup.rst (100%) rename docs/{handbook => admin}/going-into-production.rst (100%) rename docs/{handbook => admin}/index.rst (87%) rename docs/{handbook => admin}/performance/index.rst (100%) rename docs/{handbook => admin}/performance/inserts/bulk.rst (100%) rename docs/{handbook => admin}/performance/inserts/index.rst (100%) rename docs/{handbook => admin}/performance/inserts/methods.rst (100%) rename docs/{handbook => admin}/performance/inserts/parallel.rst (100%) rename docs/{handbook => admin}/performance/inserts/testing.rst (100%) rename docs/{handbook => admin}/performance/inserts/tuning.rst (100%) rename docs/{handbook => admin}/performance/memory.rst (100%) rename docs/{handbook => admin}/performance/selects.rst (100%) rename docs/{handbook => admin}/performance/sharding.rst (100%) rename docs/{handbook => admin}/sharding-partitioning.rst (100%) rename docs/{handbook => admin}/troubleshooting/crate-node.rst (100%) rename docs/{handbook => admin}/troubleshooting/docker-jcmd.rst (100%) rename docs/{handbook => admin}/troubleshooting/index.rst (100%) rename docs/{handbook => admin}/troubleshooting/systables.rst (100%) rename docs/{handbook => admin}/upgrade/full.rst (100%) rename docs/{handbook => admin}/upgrade/planning.rst (100%) rename docs/{handbook => admin}/upgrade/rolling.rst (100%) diff --git a/docs/handbook/bootstrap-checks.rst b/docs/admin/bootstrap-checks.rst similarity index 100% rename from docs/handbook/bootstrap-checks.rst rename to docs/admin/bootstrap-checks.rst diff --git a/docs/handbook/clustering/index.rst b/docs/admin/clustering/index.rst similarity index 100% rename from docs/handbook/clustering/index.rst rename to docs/admin/clustering/index.rst diff --git a/docs/handbook/clustering/kubernetes.rst b/docs/admin/clustering/kubernetes.rst similarity index 100% rename from docs/handbook/clustering/kubernetes.rst rename to docs/admin/clustering/kubernetes.rst diff --git a/docs/handbook/clustering/logical-replication-setup.rst b/docs/admin/clustering/logical-replication-setup.rst similarity index 100% rename from docs/handbook/clustering/logical-replication-setup.rst rename to docs/admin/clustering/logical-replication-setup.rst diff --git a/docs/handbook/clustering/multi-node-setup.rst b/docs/admin/clustering/multi-node-setup.rst similarity index 100% rename from docs/handbook/clustering/multi-node-setup.rst rename to docs/admin/clustering/multi-node-setup.rst diff --git a/docs/handbook/clustering/multi-zone-setup.rst b/docs/admin/clustering/multi-zone-setup.rst similarity index 100% rename from docs/handbook/clustering/multi-zone-setup.rst rename to docs/admin/clustering/multi-zone-setup.rst diff --git a/docs/handbook/going-into-production.rst b/docs/admin/going-into-production.rst similarity index 100% rename from docs/handbook/going-into-production.rst rename to docs/admin/going-into-production.rst diff --git a/docs/handbook/index.rst b/docs/admin/index.rst similarity index 87% rename from docs/handbook/index.rst rename to docs/admin/index.rst index 6c19b242..eb894698 100644 --- a/docs/handbook/index.rst +++ b/docs/admin/index.rst @@ -1,10 +1,9 @@ -.. _handbook: -.. _handbooks: -.. _user-handbooks: +.. _admin: +.. _administration: -######## -Handbook -######## +############## +Administration +############## This section of the documentation covers CrateDB database administration practices. diff --git a/docs/handbook/performance/index.rst b/docs/admin/performance/index.rst similarity index 100% rename from docs/handbook/performance/index.rst rename to docs/admin/performance/index.rst diff --git a/docs/handbook/performance/inserts/bulk.rst b/docs/admin/performance/inserts/bulk.rst similarity index 100% rename from docs/handbook/performance/inserts/bulk.rst rename to docs/admin/performance/inserts/bulk.rst diff --git a/docs/handbook/performance/inserts/index.rst b/docs/admin/performance/inserts/index.rst similarity index 100% rename from docs/handbook/performance/inserts/index.rst rename to docs/admin/performance/inserts/index.rst diff --git a/docs/handbook/performance/inserts/methods.rst b/docs/admin/performance/inserts/methods.rst similarity index 100% rename from docs/handbook/performance/inserts/methods.rst rename to docs/admin/performance/inserts/methods.rst diff --git a/docs/handbook/performance/inserts/parallel.rst b/docs/admin/performance/inserts/parallel.rst similarity index 100% rename from docs/handbook/performance/inserts/parallel.rst rename to docs/admin/performance/inserts/parallel.rst diff --git a/docs/handbook/performance/inserts/testing.rst b/docs/admin/performance/inserts/testing.rst similarity index 100% rename from docs/handbook/performance/inserts/testing.rst rename to docs/admin/performance/inserts/testing.rst diff --git a/docs/handbook/performance/inserts/tuning.rst b/docs/admin/performance/inserts/tuning.rst similarity index 100% rename from docs/handbook/performance/inserts/tuning.rst rename to docs/admin/performance/inserts/tuning.rst diff --git a/docs/handbook/performance/memory.rst b/docs/admin/performance/memory.rst similarity index 100% rename from docs/handbook/performance/memory.rst rename to docs/admin/performance/memory.rst diff --git a/docs/handbook/performance/selects.rst b/docs/admin/performance/selects.rst similarity index 100% rename from docs/handbook/performance/selects.rst rename to docs/admin/performance/selects.rst diff --git a/docs/handbook/performance/sharding.rst b/docs/admin/performance/sharding.rst similarity index 100% rename from docs/handbook/performance/sharding.rst rename to docs/admin/performance/sharding.rst diff --git a/docs/handbook/sharding-partitioning.rst b/docs/admin/sharding-partitioning.rst similarity index 100% rename from docs/handbook/sharding-partitioning.rst rename to docs/admin/sharding-partitioning.rst diff --git a/docs/handbook/troubleshooting/crate-node.rst b/docs/admin/troubleshooting/crate-node.rst similarity index 100% rename from docs/handbook/troubleshooting/crate-node.rst rename to docs/admin/troubleshooting/crate-node.rst diff --git a/docs/handbook/troubleshooting/docker-jcmd.rst b/docs/admin/troubleshooting/docker-jcmd.rst similarity index 100% rename from docs/handbook/troubleshooting/docker-jcmd.rst rename to docs/admin/troubleshooting/docker-jcmd.rst diff --git a/docs/handbook/troubleshooting/index.rst b/docs/admin/troubleshooting/index.rst similarity index 100% rename from docs/handbook/troubleshooting/index.rst rename to docs/admin/troubleshooting/index.rst diff --git a/docs/handbook/troubleshooting/systables.rst b/docs/admin/troubleshooting/systables.rst similarity index 100% rename from docs/handbook/troubleshooting/systables.rst rename to docs/admin/troubleshooting/systables.rst diff --git a/docs/handbook/upgrade/full.rst b/docs/admin/upgrade/full.rst similarity index 100% rename from docs/handbook/upgrade/full.rst rename to docs/admin/upgrade/full.rst diff --git a/docs/handbook/upgrade/planning.rst b/docs/admin/upgrade/planning.rst similarity index 100% rename from docs/handbook/upgrade/planning.rst rename to docs/admin/upgrade/planning.rst diff --git a/docs/handbook/upgrade/rolling.rst b/docs/admin/upgrade/rolling.rst similarity index 100% rename from docs/handbook/upgrade/rolling.rst rename to docs/admin/upgrade/rolling.rst diff --git a/docs/index.md b/docs/index.md index 2e8285bb..ebca5347 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,10 +44,10 @@ PostgreSQL-compatible, and based on Lucene. ::: -:::{grid-item-card} Handbook -:link: handbook +:::{grid-item-card} Administration +:link: administration :link-type: ref -:link-alt: CrateDB Handbook +:link-alt: CrateDB Administration :padding: 3 :text-align: center :class-card: sd-pt-3 @@ -150,7 +150,7 @@ optimal coverage of different application domains. install/index getting-started/index -handbook/index +admin/index integrate/index reference-architectures/index