Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/_include/card/timeseries-datashader.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ points from your backend systems to the browser's glass.
This notebook plots the venerable NYC Taxi dataset after importing it
into a CrateDB Cloud database cluster.

```{todo}
🚧 This notebook is a work in progress. 🚧
```
**Note:** 🚧 This notebook is a work in progress. 🚧


{{ '{}[cloud-datashader-github]'.format(nb_github) }} {{ '{}[cloud-datashader-colab]'.format(nb_colab) }}
:::
Expand Down
4 changes: 3 additions & 1 deletion docs/_include/links.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD034 -->
<!-- markdownlint-disable MD053 -->

[Amazon DynamoDB Streams]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html
Expand Down Expand Up @@ -60,9 +61,10 @@
[query DSL based on JSON]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
[RANK]: inv:crate-reference#window-functions-rank
[Relational Database]: https://cratedb.com/solutions/relational-database
[Replicating CDC events from DynamoDB to CrateDB]: https://cratedb.com/blog/replicating-cdc-events-from-dynamodb-to-cratedb
[Replicating CDC events to CrateDB using AWS DMS]: https://cratedb.com/blog/replicating-cdc-events-to-cratedb-using-aws-dms
[Replicating data to CrateDB with Debezium and Kafka]: https://community.cratedb.com/t/replicating-data-to-cratedb-with-debezium-and-kafka/1388
[TF–IDF]: https://en.wikipedia.org/wiki/Tf%E2%80%93idf
[Replicating CDC events from DynamoDB to CrateDB]: https://cratedb.com/blog/replicating-cdc-events-from-dynamodb-to-cratedb
[timeseries-queries-and-visualization-colab]: https://colab.research.google.com/github/crate/cratedb-examples/blob/main/topic/timeseries/timeseries-queries-and-visualization.ipynb
[timeseries-queries-and-visualization-github]: https://github.com/crate/cratedb-examples/blob/main/topic/timeseries/timeseries-queries-and-visualization.ipynb
[Vector Database (Product)]: https://cratedb.com/solutions/vector-database
Expand Down
30 changes: 25 additions & 5 deletions docs/_include/styles.html → docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
<!--
/*
Custom styles for efficient tile layouts using card elements.

TODO: Upstream to crate-docs-theme.
-->
<style>
*/

/* General */
.float-right {
float: right;
}
.clearfix {
clear: both;
}
.text-right {
text-align: right;
}
/*
.sd-card-body {
line-height: 1.1em;
Expand Down Expand Up @@ -37,7 +46,7 @@
}
.no-margin > * {
margin-top: 0 !important;
margin-bottom: 0 !important;;
margin-bottom: 0 !important;
}


Expand All @@ -51,4 +60,15 @@
margin-bottom: 1rem;
}

</style>
/* When a logo wants to be displayed next to the title */

#main-content h1 {
display: inline-flex;
align-items: center;
gap: 0.5rem; /* space between logo and title */
}
/* Optional: ensure logos inside h1 scale and align nicely */
#main-content h1 img {
vertical-align: middle;
max-height: 2rem; /* adjust as needed per design */
}
7 changes: 7 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
from crate.theme.rtd.conf.cratedb_guide import *

# Fallback guards, when parent theme does not introduce relevant variables.
if "html_css_files" not in globals():
html_css_files = []
if "html_theme_options" not in globals():
html_theme_options = {}
if "intersphinx_mapping" not in globals():
Expand Down Expand Up @@ -94,3 +96,8 @@
"tutorial": "[![Navigate to Tutorial](https://img.shields.io/badge/Navigate%20to-Tutorial-darkcyan?logo=Markdown)]",
"readmore": "[![Read More](https://img.shields.io/badge/Read-More-darkyellow?logo=Markdown)]",
})


html_css_files += [
'css/custom.css',
]
2 changes: 0 additions & 2 deletions docs/connect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::::{grid}
:padding: 0
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/blob/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/ccr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::::{grid}
:padding: 0
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/cloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/cluster/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
3 changes: 0 additions & 3 deletions docs/feature/document/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,3 @@ and about OBJECT indexing.

learn
```

```{include} /_include/styles.html
```
2 changes: 0 additions & 2 deletions docs/feature/fdw/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::::{grid}
:padding: 0
Expand Down
3 changes: 0 additions & 3 deletions docs/feature/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
(all-features)=
# All Features

:::{include} /_include/styles.html
:::

All features of CrateDB at a glance.

:::::{grid} 1 3 3 3
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/index/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/relational/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::::{grid}
:padding: 0
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/search/fts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/search/geo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/search/hybrid/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::::{grid}
:padding: 0
Expand Down
3 changes: 0 additions & 3 deletions docs/feature/search/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
(search-overview)=
# Search

:::{include} /_include/styles.html
:::

Based on Apache Lucene, CrateDB offers native BM25 term search and vector
search, all using SQL. By combining it, also using SQL, you can implement
powerful single-query hybrid search.
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/search/vector/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

**Vector search on machine learning embeddings: CrateDB is all you need.**

Expand Down
3 changes: 0 additions & 3 deletions docs/feature/snapshot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::



:::::{grid}
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/sql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::::{grid}
:padding: 0
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/storage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

The CrateDB storage layer is based on Lucene. By default, all fields are indexed,
nested or not, but the indexing can be turned off selectively.
Expand Down
2 changes: 0 additions & 2 deletions docs/feature/udf/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::


:::::{grid}
Expand Down
25 changes: 12 additions & 13 deletions docs/ingest/cdc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,21 @@
:::

:::{div}
Options to connect and integrate CrateDB with third-party
CDC applications, mostly using [CrateDB's PostgreSQL interface].
CrateDB also provides native adapter components to leverage advanced
features.

This documentation section lists CDC applications,
frameworks, and solutions, which can be used together with CrateDB,
and outlines how to use them optimally.
Additionally, see support for {ref}`generic ETL <etl>` solutions.
Options to integrate CrateDB with third‑party CDC applications, typically via
[CrateDB's PostgreSQL interface]. CrateDB also provides native adapter components
to leverage advanced features.

This section lists ETL applications and frameworks that work with CrateDB, and
outlines how to use them effectively. Additionally, see support for
{ref}`generic ETL <etl>` solutions.
:::


## Connectors

Native and specialized connectors for CrateDB, both managed and unmanaged.
Native and specialized integration connectors for CrateDB, both managed and unmanaged.

:::::{grid} 1
:::::{grid} 3
:gutter: 2

::::{grid-item-card} Amazon DynamoDB
Expand Down Expand Up @@ -51,9 +49,10 @@ or multi-cloud.

## Platforms

Support for data integration frameworks and platforms, both managed and unmanaged.
CrateDB supports popular third-party data integration frameworks and platforms,
both managed and unmanaged.

:::::{grid} 1
:::::{grid} 2
:gutter: 2

::::{grid-item-card} AWS DMS
Expand Down
21 changes: 8 additions & 13 deletions docs/ingest/etl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,14 @@

:::{include} /_include/links.md
:::
:::{include} /_include/styles.html
:::

:::{div}
Options to connect and integrate CrateDB with third-party
ETL applications, mostly using [CrateDB's PostgreSQL interface].
CrateDB also provides native adapter components to leverage advanced
features.

This documentation section lists ETL applications and
frameworks which can be used together with CrateDB, and outlines how
to use them optimally.
Additionally, see support for {ref}`cdc` solutions.
Options to integrate CrateDB with third‑party ETL applications, typically via
[CrateDB's PostgreSQL interface]. CrateDB also provides native adapter components
to leverage advanced features.

This section lists ETL applications and frameworks that work with CrateDB, and
outlines how to use them effectively. Additionally, see support for {ref}`cdc` solutions.
:::


Expand Down Expand Up @@ -69,7 +64,7 @@ Additionally, see support for {ref}`cdc` solutions.
specification, including powerful data extraction and consolidation elements.

+++
Data pipeline programming frameworks and platforms.
Use data pipeline programming frameworks and platforms.
::::


Expand Down Expand Up @@ -97,7 +92,7 @@ Data pipeline programming frameworks and platforms.
applications.

+++
Visual data flow and integration frameworks and platforms.
Use visual data flow and integration frameworks and platforms.
::::


Expand Down
3 changes: 0 additions & 3 deletions docs/ingest/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
(ingest)=
# CrateDB data ingestion

:::{include} /_include/styles.html
:::

All data ingestion methods for CrateDB at a glance.

:::::{grid} 1 2 2 2
Expand Down
Loading