From 41ede2a71c1dc8bd0785f719bc38fee6fe009a36 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Thu, 25 Sep 2025 10:46:25 +0200 Subject: [PATCH 1/9] test --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 5ef7cbc7..396bc7ce 100644 --- a/docs/index.md +++ b/docs/index.md @@ -288,7 +288,7 @@ software applications, libraries, and frameworks. :::: - +This is just a test build. ```{toctree} :hidden: From fa7c04f7623bc7db634d83bde914a1a93724bde9 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Tue, 30 Sep 2025 09:59:19 +0200 Subject: [PATCH 2/9] Extracted Getting Started from Guides --- docs/guides/index.md | 305 ++++++++++++++++++++++++++++++++++++++++ docs/index.md | 317 +----------------------------------------- docs/requirements.txt | 3 +- 3 files changed, 309 insertions(+), 316 deletions(-) create mode 100644 docs/guides/index.md diff --git a/docs/guides/index.md b/docs/guides/index.md new file mode 100644 index 00000000..18ec2723 --- /dev/null +++ b/docs/guides/index.md @@ -0,0 +1,305 @@ +(guides)= +(howtos)= +(tutorials)= +(use-more-tutorials)= + +# Guides + +Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. + + +::::{grid} 4 +:padding: 0 + + +:::{grid-item-card} Getting Started +:link: getting-started +:link-type: ref +:link-alt: Getting started with CrateDB +:padding: 1 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`rocket_launch;1.3em` +::: + + +:::{grid-item-card} Installation +:link: install +:link-type: ref +:link-alt: Installing CrateDB +:padding: 1 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`download_for_offline;1.3em` +::: + + +:::{grid-item-card} Administration +:link: administration +:link-type: ref +:link-alt: CrateDB Administration +:padding: 1 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`auto_stories;1.3em` +::: + + +:::{grid-item-card} Performance Guides +:link: performance +:link-type: ref +:link-alt: CrateDB Performance Guides +:padding: 1 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`speed;1.3em` +::: + + +:::: + + +## Features + +:::{rubric} Highlights +::: + +::::{grid} 1 2 3 3 +:padding: 0 + +:::{grid-item-card} Document Store +:link: document +:link-type: ref +:link-alt: Storing JSON documents using CrateDB's `OBJECT` data type +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`article;1.3em` +::: + +:::{grid-item-card} Search +:link: search-overview +:link-type: ref +:link-alt: About CrateDB's search capabilities +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`manage_search;1.3em` +::: + +:::{grid-item-card} Advanced Querying +:link: advanced-querying +:link-type: ref +:link-alt: About CrateDB's advanced querying capabilities +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`engineering;1.3em` +::: + +:::: + +:::{card} All features +:link: all-features +:link-type: ref + +CrateDB is a distributed and scalable SQL database for storing and analyzing +massive amounts of data in near real-time, even with complex queries. It is +based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. + +![](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png) ++++ +Read about all features of CrateDB at a glance. +::: + + +## Data ingestion + +Load data into CrateDB. + +::::{grid} 1 2 3 3 +:padding: 0 + +:::{grid-item-card} ETL +:link: etl +:link-type: ref +:link-alt: Load and export data into/from CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`transform;1.3em` +::: + +:::{grid-item-card} CDC +:link: cdc +:link-type: ref +:link-alt: Change Data Capture (CDC) into CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`double_arrow;1.3em` +::: + +:::{grid-item-card} Telemetry +:link: telemetry +:link-type: ref +:link-alt: Use CrateDB with metrics collection agents, brokers, and stores +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`query_stats;1.3em` +::: + +:::: + + +## Solutions + +Learn how others are using CrateDB successfully. + +::::{grid} 1 2 3 3 +:padding: 0 + +:::{grid-item-card} Solutions and use cases +:link: solutions +:link-type: ref +:link-alt: Solutions built with CrateDB +:padding: 1 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`lightbulb;1.3em` +::: + +:::: + + +## Topics + +Learn how to apply CrateDB's features to optimally cover use-cases across different +application and topic domains, for example, by connecting CrateDB with third-party +software applications, libraries, and frameworks. + +::::{grid} 1 2 3 3 +:padding: 0 + + +:::{grid-item-card} Business Intelligence +:link: bi +:link-type: ref +:link-alt: Analyse information with CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`analytics;1.3em` +::: + +:::{grid-item-card} Data Visualization +:link: visualization +:link-type: ref +:link-alt: Data visualization with CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`bar_chart;1.3em` +::: + + +:::{grid-item-card} Machine Learning +:link: machine-learning +:link-type: ref +:link-alt: Machine Learning with CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`model_training;1.3em` +::: + + +:::{grid-item-card} Software Testing +:link: testing +:link-type: ref +:link-alt: Software testing with CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`integration_instructions;1.3em` +::: + + +:::{grid-item-card} Time Series Data +:link: timeseries +:link-type: ref +:link-alt: Managing Time Series Data with CrateDB +:padding: 3 +:text-align: center +:class-card: sd-pt-3 +:class-body: sd-fs-1 +:class-title: sd-fs-5 + +{material-outlined}`stacked_line_chart;1.3em` +::: + + +:::: + + +```{toctree} +:hidden: + +../install/index +../connect/index +../feature/index +Ingestion <../ingest/index> +../topic/index +Solutions <../solution/index> +../integrate/index +../admin/index +../performance/index +``` + +[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015 diff --git a/docs/index.md b/docs/index.md index 396bc7ce..8fd19d62 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,322 +1,9 @@ (index)= -(guides)= -(howtos)= -(tutorials)= -(use-more-tutorials)= - -# The CrateDB Guide - -Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. - - -::::{grid} 4 -:padding: 0 - - -:::{grid-item-card} Getting Started -:link: getting-started -:link-type: ref -:link-alt: Getting started with CrateDB -:padding: 1 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`rocket_launch;1.3em` -::: - - -:::{grid-item-card} Installation -:link: install -:link-type: ref -:link-alt: Installing CrateDB -:padding: 1 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`download_for_offline;1.3em` -::: - - -:::{grid-item-card} Administration -:link: administration -:link-type: ref -:link-alt: CrateDB Administration -:padding: 1 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`auto_stories;1.3em` -::: - - -:::{grid-item-card} Performance Guides -:link: performance -:link-type: ref -:link-alt: CrateDB Performance Guides -:padding: 1 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`speed;1.3em` -::: - - -:::: - - -## Features - -:::{rubric} Highlights -::: - -::::{grid} 1 2 3 3 -:padding: 0 - -:::{grid-item-card} Document Store -:link: document -:link-type: ref -:link-alt: Storing JSON documents using CrateDB's `OBJECT` data type -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`article;1.3em` -::: - -:::{grid-item-card} Search -:link: search-overview -:link-type: ref -:link-alt: About CrateDB's search capabilities -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`manage_search;1.3em` -::: - -:::{grid-item-card} Advanced Querying -:link: advanced-querying -:link-type: ref -:link-alt: About CrateDB's advanced querying capabilities -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`engineering;1.3em` -::: - -:::: - -:::{card} All features -:link: all-features -:link-type: ref - -CrateDB is a distributed and scalable SQL database for storing and analyzing -massive amounts of data in near real-time, even with complex queries. It is -based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. - -![](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png) -+++ -Read about all features of CrateDB at a glance. -::: - - -## Data ingestion - -Load data into CrateDB. - -::::{grid} 1 2 3 3 -:padding: 0 - -:::{grid-item-card} ETL -:link: etl -:link-type: ref -:link-alt: Load and export data into/from CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`transform;1.3em` -::: - -:::{grid-item-card} CDC -:link: cdc -:link-type: ref -:link-alt: Change Data Capture (CDC) into CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`double_arrow;1.3em` -::: - -:::{grid-item-card} Telemetry -:link: telemetry -:link-type: ref -:link-alt: Use CrateDB with metrics collection agents, brokers, and stores -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`query_stats;1.3em` -::: - -:::: - - -## Solutions - -Learn how others are using CrateDB successfully. - -::::{grid} 1 2 3 3 -:padding: 0 - -:::{grid-item-card} Solutions and use cases -:link: solutions -:link-type: ref -:link-alt: Solutions built with CrateDB -:padding: 1 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`lightbulb;1.3em` -::: - -:::: - - -## Topics - -Learn how to apply CrateDB's features to optimally cover use-cases across different -application and topic domains, for example, by connecting CrateDB with third-party -software applications, libraries, and frameworks. - -::::{grid} 1 2 3 3 -:padding: 0 - - -:::{grid-item-card} Business Intelligence -:link: bi -:link-type: ref -:link-alt: Analyse information with CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`analytics;1.3em` -::: - -:::{grid-item-card} Data Visualization -:link: visualization -:link-type: ref -:link-alt: Data visualization with CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`bar_chart;1.3em` -::: - - -:::{grid-item-card} Machine Learning -:link: machine-learning -:link-type: ref -:link-alt: Machine Learning with CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`model_training;1.3em` -::: - - -:::{grid-item-card} Software Testing -:link: testing -:link-type: ref -:link-alt: Software testing with CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`integration_instructions;1.3em` -::: - - -:::{grid-item-card} Time Series Data -:link: timeseries -:link-type: ref -:link-alt: Managing Time Series Data with CrateDB -:padding: 3 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`stacked_line_chart;1.3em` -::: - - -:::: - -This is just a test build. ```{toctree} :hidden: start/index -install/index -connect/index -feature/index -Ingestion -topic/index -Solutions -integrate/index -admin/index -performance/index -``` - +Guides -:::{note} -CrateDB and its documentation are open source projects. -Contributions to all pages are much appreciated. -If you can spot a flaw, or would like to contribute additional content, you -are most welcome. - -For navigating to the relevant page where this project is hosted on [GitHub], -to submit change requests fluently, you will find corresponding links within -the topmost right navigation element on each page. -::: - - -[GitHub]: https://github.com/crate/cratedb-guide -[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015 +``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 711beaff..c7c361a6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,5 @@ -crate-docs-theme>=0.40.0.dev0 +# crate-docs-theme>=0.40.1 +-e file:/Users/bmunkholm/code/c/docs/crate-docs-theme # cache-buster-20240305 # Remark: Used for PyPI download cache busting on GHA. From 37bdb3de764323a2531faa8333f2f3e0a9ee46a7 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Sun, 5 Oct 2025 00:40:50 +0200 Subject: [PATCH 3/9] Move overview --- docs/index.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/index.md b/docs/index.md index 8fd19d62..2db00ef2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,17 @@ (index)= + + ```{toctree} :hidden: +Overview start/index Guides From a3a9bed77a209b5323d134b8a5a30020666fc8c9 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Sun, 5 Oct 2025 20:52:30 +0200 Subject: [PATCH 4/9] Adjust required theme version. --- docs/home/index.md | 7 +------ docs/requirements.txt | 7 +++++-- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/home/index.md b/docs/home/index.md index 571faac5..ec5e20c5 100644 --- a/docs/home/index.md +++ b/docs/home/index.md @@ -1,8 +1,3 @@ ---- -orphan: true ---- - - # Welcome to CrateDB CrateDB is a **distributed SQL database** designed for **real-time analytics @@ -385,7 +380,7 @@ Make sure you also do not miss relevant [CrateDB customer stories]. [CrateDB customer stories]: https://www.youtube.com/playlist?list=PLDZqzXOGoWUJrAF_lVx9U6BzAGG9xYz_v [HTTP protocol]: https://en.wikipedia.org/wiki/HTTP -[JDBC]: https://en.wikipedia.org/wiki/Java_Database_Connectivity +[JDBC]: https://en.wikipedia.org/wiki/Java_Database_Connectivity [ODBC]: https://en.wikipedia.org/wiki/Open_Database_Connectivity [PostgreSQL wire protocol]: https://www.postgresql.org/docs/current/protocol.html [sharing a playlist of videos]: https://www.youtube.com/playlist?list=PL3cZtICBssphXl5rHgsgG9vTNAVTw_Veq diff --git a/docs/requirements.txt b/docs/requirements.txt index c7c361a6..ee4a0783 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,8 @@ -# crate-docs-theme>=0.40.1 --e file:/Users/bmunkholm/code/c/docs/crate-docs-theme +crate-docs-theme>=0.41 + +# Comment the first line and uncomment and adjust path in the following line +# to use a local version of crate-docs-theme: +# -e file:/Users/yourpath/crate-docs-theme # cache-buster-20240305 # Remark: Used for PyPI download cache busting on GHA. From 6d34c797c9fdc9972817073ad94c8125bd61e5c3 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Mon, 6 Oct 2025 10:44:08 +0200 Subject: [PATCH 5/9] Fixed accessibility hint for overview diagram. --- docs/guides/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 18ec2723..46a471a5 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -128,7 +128,7 @@ CrateDB is a distributed and scalable SQL database for storing and analyzing massive amounts of data in near real-time, even with complex queries. It is based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. -![](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png) +![CrateDB feature overview diagram](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png) +++ Read about all features of CrateDB at a glance. ::: From fb528469c3d04cbdd486791e216a748659eda7d5 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Mon, 6 Oct 2025 10:44:51 +0200 Subject: [PATCH 6/9] temporarily use dev0 version of theme for previewing --- docs/requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index ee4a0783..90883b7d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,8 +1,8 @@ -crate-docs-theme>=0.41 +crate-docs-theme>=0.41.0.dev0 # Comment the first line and uncomment and adjust path in the following line # to use a local version of crate-docs-theme: -# -e file:/Users/yourpath/crate-docs-theme +# -e file:/Users/bmunkholm/code/c/docs/crate-docs-theme # cache-buster-20240305 # Remark: Used for PyPI download cache busting on GHA. From 9163295b04467e657af87314e02ce1d69ab532b5 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Mon, 6 Oct 2025 10:50:15 +0200 Subject: [PATCH 7/9] Remove unused reference. --- docs/guides/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 46a471a5..9b1809bb 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -301,5 +301,3 @@ Solutions <../solution/index> ../admin/index ../performance/index ``` - -[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015 From 5446196a5f23ef8335917598981fdcac7749cdd1 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Mon, 6 Oct 2025 10:53:28 +0200 Subject: [PATCH 8/9] Removed Getting Started from Guides, as it's been moved out 1 level --- docs/guides/index.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 9b1809bb..ac4de355 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -11,21 +11,6 @@ Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. ::::{grid} 4 :padding: 0 - -:::{grid-item-card} Getting Started -:link: getting-started -:link-type: ref -:link-alt: Getting started with CrateDB -:padding: 1 -:text-align: center -:class-card: sd-pt-3 -:class-body: sd-fs-1 -:class-title: sd-fs-5 - -{material-outlined}`rocket_launch;1.3em` -::: - - :::{grid-item-card} Installation :link: install :link-type: ref From 3a0f51c3ea254615c1f32111d6c2e627e84947d4 Mon Sep 17 00:00:00 2001 From: Brian Munkholm Date: Mon, 6 Oct 2025 16:48:13 +0200 Subject: [PATCH 9/9] renamed guide to handbook --- docs/{guides => handbook}/index.md | 2 +- docs/index.md | 2 +- docs/requirements.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename docs/{guides => handbook}/index.md (99%) diff --git a/docs/guides/index.md b/docs/handbook/index.md similarity index 99% rename from docs/guides/index.md rename to docs/handbook/index.md index ac4de355..208720f9 100644 --- a/docs/guides/index.md +++ b/docs/handbook/index.md @@ -3,7 +3,7 @@ (tutorials)= (use-more-tutorials)= -# Guides +# Handbook Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. diff --git a/docs/index.md b/docs/index.md index 2db00ef2..5f2106e3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,6 +13,6 @@ Look for the "Section A: Guide" section in the {% else %} branch. Overview start/index -Guides +handbook/index ``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 90883b7d..768dec5f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -crate-docs-theme>=0.41.0.dev0 +crate-docs-theme>=0.41.0.dev1 # Comment the first line and uncomment and adjust path in the following line # to use a local version of crate-docs-theme: