Features: Add dedicated pages about...

amotl · amotl · commit 9d205d0c3441 · 2024-03-05T02:14:04.000+01:00
blob, cloud, cluster, fdw, query, replication, snapshot, sql, vector
diff --git a/docs/_include/styles.html b/docs/_include/styles.html
@@ -4,9 +4,11 @@
 TODO: Upstream to crate-docs-theme.
 -->
 <style>
+/*
 .sd-card-body {
     line-height: 1.1em;
 }
+*/
 .sd-card-footer {
     font-size: small;
 }
diff --git a/docs/admin/clustering/index.rst b/docs/admin/clustering/index.rst
@@ -1,4 +1,4 @@
-.. _clustering:
+.. _admin-clustering:
 
 ==========
 Clustering
diff --git a/docs/feature/blob/index.md b/docs/feature/blob/index.md
@@ -0,0 +1,6 @@
+(blob)=
+
+# BLOB Store
+
+:::{todo} Implement.
+:::
diff --git a/docs/feature/cloud/index.md b/docs/feature/cloud/index.md
@@ -0,0 +1,6 @@
+(cloud)=
+
+# Cloud Native
+
+:::{todo} Implement.
+:::
diff --git a/docs/feature/cluster/index.md b/docs/feature/cluster/index.md
@@ -0,0 +1,25 @@
+(clustering)=
+
+# Clustering
+
+:::{todo} Implement.
+
+About scalability through partitioning, sharding, and replication.
+Also about cross cluster replication.
+:::
+
+
+:::{seealso}
+**Domains:**
+[](#metrics-store) •
+[](#analytics) •
+[](#industrial) •
+[](#timeseries) •
+[](#machine-learning)
+
+**Product:**
+[Relational Database]
+:::
+
+
+[Relational Database]: https://cratedb.com/solutions/relational-database
diff --git a/docs/feature/fdw/index.md b/docs/feature/fdw/index.md
@@ -0,0 +1,15 @@
+(fdw)=
+
+# Foreign Data Wrapper
+
+:::{todo} Implement.
+:::
+
+
+:::{seealso}
+**Product:**
+[Relational Database]
+:::
+
+
+[Relational Database]: https://cratedb.com/solutions/relational-database
diff --git a/docs/feature/index.md b/docs/feature/index.md
@@ -5,17 +5,55 @@
 
 All features of CrateDB at a glance.
 
-```{toctree}
-:maxdepth: 1
+:::::{grid} 1 3 3 3
+:margin: 4 4 0 0
+:padding: 0
+:gutter: 2
 
-document/index
+::::{grid-item-card} {material-outlined}`lightbulb;2em` Fundamentals
+:::{toctree}
+:maxdepth: 1
+sql/index
 relational/index
+document/index
 search/index
 geospatial/index
+blob/index
+vector/index
+:::
++++
+CrateDB combines the advantages of traditional SQL databases with the
+best properties of NoSQL databases.
+::::
+
+::::{grid-item-card} {material-outlined}`group;2em` Operational
+:::{toctree}
+:maxdepth: 1
+cluster/index
+snapshot/index
 connectivity/index
+cloud/index
+:::
++++
+CrateDB scales horizontally using a shared-nothing
+architecture, inherited from Elasticsearch.
+::::
+
+::::{grid-item-card} {material-outlined}`read_more;2em` More
+:::{toctree}
+:maxdepth: 1
+query/index
 generated/index
+fdw/index
 udf/index
-```
+replication/index
+:::
++++
+Advanced features supporting daily data
+operations, all based on standard SQL.
+::::
+
+:::::
 
 
 :::{rubric} Features and Use Cases
@@ -60,3 +98,7 @@ full-text search engine library.
 
 
 ::::
+
+
+```{include} /_include/styles.html
+```
diff --git a/docs/feature/query/index.md b/docs/feature/query/index.md
@@ -0,0 +1,16 @@
+(query)=
+(querying)=
+
+# Advanced Querying
+
+:::{todo} Implement.
+:::
+
+
+(aggregation)=
+(aggregations)=
+
+## Aggregations
+
+:::{todo} Implement.
+:::
diff --git a/docs/feature/replication/index.md b/docs/feature/replication/index.md
@@ -0,0 +1,6 @@
+(replication)=
+
+# Cross-Cluster Replication
+
+:::{todo} Implement.
+:::
diff --git a/docs/feature/snapshot/index.md b/docs/feature/snapshot/index.md
@@ -0,0 +1,6 @@
+(snapshot)=
+
+# Snapshots
+
+:::{todo} Implement.
+:::
diff --git a/docs/feature/sql/index.md b/docs/feature/sql/index.md
@@ -0,0 +1,34 @@
+(sql)=
+
+# SQL
+
+:::{todo} Implement.
+:::
+
+
+CrateDB is wire-protocol compatible to PostgreSQL, and you can use all of its
+features using plain SQL.
+Other than integrating well with commodity systems using standard database
+access interfaces like ODBC or JDBC, it provides a proprietary HTTP interface
+on top.
+
+You have a variety of options to connect to CrateDB, and to integrate it with
+off-the-shelve, 3rd-party, open-source, and proprietary applications.
+
+See {ref}`connect`.
+
+
+:::{seealso}
+**Domains:**
+[](#metrics-store) •
+[](#analytics) •
+[](#industrial) •
+[](#timeseries) •
+[](#machine-learning)
+
+**Product:**
+[Relational Database]
+:::
+
+
+[Relational Database]: https://cratedb.com/solutions/relational-database
diff --git a/docs/feature/vector/index.md b/docs/feature/vector/index.md
@@ -0,0 +1,16 @@
+(hnsw)=
+(vector)=
+
+# Vector Store
+
+:::{todo} Implement.
+:::
+
+
+:::{seealso}
+**Product:**
+[Relational Database]
+:::
+
+
+[Relational Database]: https://cratedb.com/solutions/relational-database

Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,11 @@`
`4`	`4`	`TODO: Upstream to crate-docs-theme.`
`5`	`5`	`-->`
`6`	`6`	`<style>`
	`7`	`+/*`
`7`	`8`	`.sd-card-body {`
`8`	`9`	`line-height: 1.1em;`
`9`	`10`	`}`
	`11`	`+*/`
`10`	`12`	`.sd-card-footer {`
`11`	`13`	`font-size: small;`
`12`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. _clustering:`
	`1`	`+.. _admin-clustering:`
`2`	`2`
`3`	`3`	`==========`
`4`	`4`	`Clustering`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +(blob)=
++
 +# BLOB Store
++
 +:::{todo} Implement.
 +:::