From 74f7ef5194b7a8d17b55d67ea117f52dc4798642 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Sun, 5 Oct 2025 23:15:16 +0200 Subject: [PATCH 1/2] Start/Index: Refactor "Going further" to "Learn more" on index page --- docs/start/going-further.md | 114 ------------------------------ docs/start/index.md | 136 ++++++++++++++++++++++++++++-------- 2 files changed, 108 insertions(+), 142 deletions(-) delete mode 100644 docs/start/going-further.md diff --git a/docs/start/going-further.md b/docs/start/going-further.md deleted file mode 100644 index 3c0e3b0d..00000000 --- a/docs/start/going-further.md +++ /dev/null @@ -1,114 +0,0 @@ -(start-going-further)= -# Going further - -To learn more about CrateDB, we invite you to explore the other sections -of the documentation portal. - -:::::{card} - -::::{sd-table} -:widths: 4 8 -:row-class: top-border - -:::{sd-row} -```{sd-item} **Topic** -``` -```{sd-item} **Description** -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Data modelling ` -``` -```{sd-item} -Learn the different types of structured, semi-structured, and unstructured data. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Query capabilities ` -``` -```{sd-item} -Explore CrateDB’s key query capabilities, such as aggregations, ad-hoc queries, -search and AI integration on large datasets at scale. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Drivers ` -``` -```{sd-item} -Connect CrateDB to your applications using official drivers. Also explore CrateDB CLI tools. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Integrations ` -``` -```{sd-item} -Use CrateDB with third-party adapters, connectors, data sources, and integrations. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Reference manual ` -``` -```{sd-item} -Access the complete technical reference manual for CrateDB, and learn about -its concepts and details. -``` -::: - -:::{sd-row} -```{sd-item} Advanced guides -:class: sd-font-weight-bolder -``` -```{sd-item} -Dive deeper into clustering concepts, reference architectures, installation, deployment, migration, and upgrades. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Sample applications ` -``` -```{sd-item} -Explore ready-to-run sample projects that demonstrate how to build real-world solutions using CrateDB. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -{ref}`Database management ` -``` -```{sd-item} -Learn to manage your cluster with ease: configuration, sizing, performance tuning, -and cost optimization. Explore monitoring, alerting, and automation. -``` -::: - -:::{sd-row} -```{sd-item} -:class: sd-font-weight-bolder -[Support and learning ↗](https://learn.cratedb.com/) -``` -```{sd-item} -Get access to more resources to continue learning. -``` -::: - -:::: - -::::: diff --git a/docs/start/index.md b/docs/start/index.md index c71a511f..63b80439 100644 --- a/docs/start/index.md +++ b/docs/start/index.md @@ -7,7 +7,7 @@ Get up and running with CrateDB: Install, connect, run your first queries, and explore key features. ::: -:::{rubric} Warm-up +:::{rubric} Warm up ::: :::::{grid} 2 2 2 4 @@ -71,50 +71,130 @@ and explore key features. :::: ::::: +(start-going-further)= + :::{rubric} Learn more ::: -:::::{grid} 2 2 2 4 -:padding: 0 -:class-container: installation-grid +To learn more about CrateDB, we invite you to explore the other sections +of the documentation portal. -::::{grid-item-card} Sample Applications -:link: example-applications -:link-type: ref -:link-alt: Sample Applications -:columns: 6 3 3 3 -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-6 +:::::{card} -{fas}`handshake` -:::: +::::{sd-table} +:widths: 4 8 +:row-class: top-border -::::{grid-item-card} Going Further -:link: start-going-further -:link-type: ref -:link-alt: Going Further -:columns: 6 3 3 3 -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-6 +:::{sd-row} +```{sd-item} **Topic** +``` +```{sd-item} **Description** +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Data modelling ` +``` +```{sd-item} +Learn the different types of structured, semi-structured, and unstructured data. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Query capabilities ` +``` +```{sd-item} +Explore CrateDB’s key query capabilities, such as aggregations, ad-hoc queries, +search and AI integration on large datasets at scale. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Drivers ` +``` +```{sd-item} +Connect CrateDB to your applications using official drivers. Also explore CrateDB CLI tools. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Integrations ` +``` +```{sd-item} +Use CrateDB with third-party adapters, connectors, data sources, and integrations. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Reference manual ` +``` +```{sd-item} +Access the complete technical reference manual for CrateDB, and learn about +its concepts and details. +``` +::: + +:::{sd-row} +```{sd-item} Advanced guides +:class: sd-font-weight-bolder +``` +```{sd-item} +Dive deeper into clustering concepts, reference architectures, installation, deployment, migration, and upgrades. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Sample applications ` +``` +```{sd-item} +Explore ready-to-run sample projects that demonstrate how to build real-world solutions using CrateDB. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +{ref}`Database management ` +``` +```{sd-item} +Learn to manage your cluster with ease: configuration, sizing, performance tuning, +and cost optimization. Explore monitoring, alerting, and automation. +``` +::: + +:::{sd-row} +```{sd-item} +:class: sd-font-weight-bolder +[Support and learning ↗](https://learn.cratedb.com/) +``` +```{sd-item} +Get access to more resources to continue learning. +``` +::: -{fas}`box-open` :::: ::::: + ```{toctree} :maxdepth: 1 :hidden: first-steps -going-further modelling/index query/index Ingesting data <../ingest/index> From 384df94cc11152652337529973458f18ff6a404b Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Sun, 5 Oct 2025 23:34:56 +0200 Subject: [PATCH 2/2] Start/Index: Remove empty "Advanced guides". Add "Performance guides". --- docs/performance/index.md | 2 +- docs/start/index.md | 21 +++++++++++++-------- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/performance/index.md b/docs/performance/index.md index 57037473..f3f205a1 100644 --- a/docs/performance/index.md +++ b/docs/performance/index.md @@ -1,6 +1,6 @@ (performance)= (performance-guides)= -# Performance Guides +# Performance guides :::{div} sd-text-muted Best practices and tips for sharding, scaling, and performance tuning. diff --git a/docs/start/index.md b/docs/start/index.md index 63b80439..96a958b3 100644 --- a/docs/start/index.md +++ b/docs/start/index.md @@ -77,7 +77,7 @@ and explore key features. ::: To learn more about CrateDB, we invite you to explore the other sections -of the documentation portal. +of the documentation. :::::{card} @@ -145,32 +145,37 @@ its concepts and details. ::: :::{sd-row} -```{sd-item} Advanced guides +```{sd-item} :class: sd-font-weight-bolder +{ref}`Sample applications ` ``` ```{sd-item} -Dive deeper into clustering concepts, reference architectures, installation, deployment, migration, and upgrades. +Explore ready-to-run sample projects that demonstrate how to build real-world solutions using CrateDB. ``` ::: :::{sd-row} ```{sd-item} :class: sd-font-weight-bolder -{ref}`Sample applications ` +{ref}`Database management ` ``` ```{sd-item} -Explore ready-to-run sample projects that demonstrate how to build real-world solutions using CrateDB. +Learn to manage your cluster: configuration, sizing, +production deployment, migration and upgrade procedures, +sharding and partitioning, troubleshooting, user creation, +and cost optimization. Explore monitoring, alerting, and automation. ``` ::: :::{sd-row} ```{sd-item} :class: sd-font-weight-bolder -{ref}`Database management ` +{ref}`performance` ``` ```{sd-item} -Learn to manage your cluster with ease: configuration, sizing, performance tuning, -and cost optimization. Explore monitoring, alerting, and automation. +Learn about best practices and recommendations to ensure optimal +system efficiency. Key points include performance tuning details around +selecting your sharding strategy, storage advice, and query optimization guidelines. ``` :::