Refactoring: Improve "Performance" section, making it a first-level item

The "Performance" section includes so much valuable content, and is not strictly related to "Administration" purposes, so this patch moves it to the first level of CrateDB Guides, because it is an important topic. The single item which was relevant for "Administration" purposes, was the page about "Memory Configuration", which has been moved, well, into the "Administration" section.
crate · Feb 27, 2024 · 4bfe4bb · 4bfe4bb
1 parent 9edcce0
commit 4bfe4bb
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 21 deletions.
diff --git a/docs/admin/index.rst b/docs/admin/index.rst
@@ -13,6 +13,7 @@ CrateDB database administration practices.
     bootstrap-checks
     create-user
     going-into-production
+    memory
     troubleshooting/index
 
 
@@ -24,7 +25,7 @@ clustering, sharding, partitioning, and performance tuning.
 
     clustering/index
     sharding-partitioning
-    performance/index
+    ../performance/index
 
 
 Guidelines about upgrading CrateDB.

diff --git a/docs/admin/performance/memory.rst → docs/admin/memory.rst b/docs/admin/performance/memory.rst → docs/admin/memory.rst
diff --git a/docs/admin/performance/index.rst b/docs/admin/performance/index.rst
diff --git a/docs/index.md b/docs/index.md
@@ -13,7 +13,7 @@ massive amounts of data in near real-time, even with complex queries. It is
 PostgreSQL-compatible, and based on Lucene. 
 
 
-::::{grid} 3
+::::{grid} 2
 :padding: 0
 
 
@@ -59,6 +59,20 @@ PostgreSQL-compatible, and based on Lucene.
 :::
 
 
+:::{grid-item-card} Performance Guides
+:link: performance
+:link-type: ref
+:link-alt: CrateDB Performance Guides
+:padding: 3
+:text-align: center
+:class-card: sd-pt-3
+:class-body: sd-fs-1
+:class-title: sd-fs-5
+
+{material-outlined}`speed;1.3em`
+:::
+
+
 ::::
 
 
@@ -272,9 +286,10 @@ use-cases.
 install/index
 getting-started
 admin/index
+performance/index
+
 domain/index
 integrate/index
-
 reference-architectures/index
 ```
 

diff --git a/docs/performance/index.rst b/docs/performance/index.rst
@@ -0,0 +1,17 @@
+.. _performance:
+
+==================
+Performance Guides
+==================
+
+Best practices and tips for common scenarios around the topics of
+performance tuning and sharding.
+
+.. rubric:: Table of contents
+
+.. toctree::
+   :maxdepth: 2
+
+   sharding
+   inserts/index
+   selects
diff --git a/docs/admin/performance/inserts/bulk.rst → docs/performance/inserts/bulk.rst b/docs/admin/performance/inserts/bulk.rst → docs/performance/inserts/bulk.rst
diff --git a/docs/admin/performance/inserts/index.rst → docs/performance/inserts/index.rst b/docs/admin/performance/inserts/index.rst → docs/performance/inserts/index.rst
diff --git a/docs/admin/performance/inserts/methods.rst → docs/performance/inserts/methods.rst b/docs/admin/performance/inserts/methods.rst → docs/performance/inserts/methods.rst
diff --git a/docs/admin/performance/inserts/parallel.rst → docs/performance/inserts/parallel.rst b/docs/admin/performance/inserts/parallel.rst → docs/performance/inserts/parallel.rst
diff --git a/docs/admin/performance/inserts/testing.rst → docs/performance/inserts/testing.rst b/docs/admin/performance/inserts/testing.rst → docs/performance/inserts/testing.rst
diff --git a/docs/admin/performance/inserts/tuning.rst → docs/performance/inserts/tuning.rst b/docs/admin/performance/inserts/tuning.rst → docs/performance/inserts/tuning.rst
diff --git a/docs/admin/performance/selects.rst → docs/performance/selects.rst b/docs/admin/performance/selects.rst → docs/performance/selects.rst
diff --git a/docs/admin/performance/sharding.rst → docs/performance/sharding.rst b/docs/admin/performance/sharding.rst → docs/performance/sharding.rst
@@ -1,7 +1,7 @@
 .. _sharding_guide:
 
 ==============
-Sharding guide
+Sharding Guide
 ==============
 
 This document is a sharding best practice guide for CrateDB.