Skip to content
288 changes: 288 additions & 0 deletions docs/handbook/index.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to relocate the previous docs/index page here, as this becomes a submenu now, and the "root" page will no longer exist.

Can you rename this to handbook, to accompany the other patch?

Original file line number Diff line number Diff line change
@@ -0,0 +1,288 @@
(guides)=
(howtos)=
(tutorials)=
(use-more-tutorials)=

# Handbook

Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice.


::::{grid} 4
:padding: 0

:::{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.

![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.
:::


## 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
```
5 changes: 0 additions & 5 deletions docs/home/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
orphan: true
---


# Welcome to CrateDB

CrateDB is a **distributed SQL database** designed for **real-time analytics
Expand Down
Loading
Loading