Skip to content

Commit f7b47dc

Browse files
committed
Feature: Improve guidance into new documentation section
1 parent 316dd11 commit f7b47dc

File tree

2 files changed

+51
-50
lines changed

2 files changed

+51
-50
lines changed

docs/feature/index.md

Lines changed: 44 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
(feature)=
22
(features)=
3-
3+
(all-features)=
44
# All Features
55

6+
:::{include} /_include/styles.html
7+
:::
8+
69
All features of CrateDB at a glance.
710

811
:::::{grid} 1 3 3 3
912
:margin: 4 4 0 0
1013
:padding: 0
1114
:gutter: 2
1215

13-
::::{grid-item-card} {material-outlined}`lightbulb;2em` Fundamentals
16+
::::{grid-item-card} {material-outlined}`lightbulb;2em` Functional
1417
:::{toctree}
1518
:maxdepth: 1
1619

1720
sql/index
21+
connectivity/index
1822
relational/index
1923
document/index
2024
search/index
@@ -31,11 +35,6 @@ industry-standard SQL.
3135
:::{toctree}
3236
:maxdepth: 1
3337

34-
connectivity/index
35-
:::
36-
:::{toctree}
37-
:maxdepth: 1
38-
3938
cluster/index
4039
snapshot/index
4140
cloud/index
@@ -50,6 +49,7 @@ architecture, inherited from Elasticsearch.
5049
::::{grid-item-card} {material-outlined}`read_more;2em` Advanced
5150
:::{toctree}
5251
:maxdepth: 1
52+
5353
query/index
5454
generated/index
5555
cursor/index
@@ -65,90 +65,84 @@ operations, all based on standard SQL.
6565
:::::
6666

6767

68-
:::{rubric} Features and Use Cases
69-
:::
70-
71-
Foundational features of CrateDB, and how they are applied within software
72-
solutions and application platforms in different scenarios and environments.
73-
74-
75-
:::{rubric} Features
68+
:::{rubric} Connect and Integrate
7669
:::
70+
Connect to CrateDB using traditional database drivers, and integrate CrateDB
71+
with popular 3rd-party applications in open-source and proprietary software
72+
landscapes.
7773

7874
::::{grid} 1 2 2 2
7975
:margin: 4 4 0 0
8076
:padding: 0
8177
:gutter: 2
8278

83-
84-
:::{grid-item-card} {material-outlined}`description;2em` Document Store
85-
:link: document
79+
:::{grid-item-card} {material-outlined}`link;2em` Connectivity
80+
:link: connectivity
8681
:link-type: ref
87-
:link-alt: About CrateDB's OBJECT data type
82+
:link-alt: About connection options with CrateDB
8883

89-
Learn how to use CrateDB's OBJECT data type to efficiently store JSON or
90-
other structured data, also nested, and how to query this data with ease.
84+
Connect to your CrateDB cluster using drivers, frameworks, and adapters.
9185
+++
9286
**What's inside:**
93-
CrateDB can do the same like Lotus Notes / Domino, CouchDB, MongoDB,
94-
and PostgreSQL's JSON data type.
87+
Connectivity and integration options with database drivers
88+
and applications, libraries, and frameworks.
9589
:::
9690

9791

98-
:::{grid-item-card} {material-outlined}`manage_search;2em` Full-Text Search
99-
:link: fulltext
92+
:::{grid-item-card} {material-outlined}`sync;2em` Import and Export
93+
:link: import-export
10094
:link-type: ref
101-
:link-alt: About CrateDB's full-text search capabilities
95+
:link-alt: About time series data import and export
10296

103-
Learn how to set up your database for full-text search, and how to query
104-
text data efficiently, to make sense of large volumes of unstructured
105-
information.
97+
Import data into and export data from your CrateDB cluster.
10698
+++
10799
**What's inside:**
108-
Like Elasticsearch, CrateDB is based on Lucene, the premier industry-grade
109-
full-text search engine library.
100+
A variety of options to connect and integrate with 3rd-party
101+
ETL applications.
110102
:::
111103

112104
::::
113105

114106

115-
:::{rubric} See Also
107+
:::{rubric} Highlights
116108
:::
117-
Connect to and integrate with CrateDB.
109+
Important fundamental features of CrateDB, and how they are applied within software
110+
solutions and application platforms in different scenarios and environments.
118111

119112
::::{grid} 1 2 2 2
120113
:margin: 4 4 0 0
121114
:padding: 0
122115
:gutter: 2
123116

124-
:::{grid-item-card} {material-outlined}`link;2em` Connectivity
125-
:link: connectivity
117+
118+
:::{grid-item-card} {material-outlined}`description;2em` Document Store
119+
:link: document
126120
:link-type: ref
127-
:link-alt: About connection options with CrateDB
121+
:link-alt: About CrateDB's OBJECT data type
128122

129-
Connect to your CrateDB cluster using drivers, frameworks, and adapters.
123+
Learn about CrateDB's OBJECT data type, how to efficiently store JSON
124+
or other structured data, also nested, and how to query this data with
125+
ease, fully indexed thus performant from the start, optionally using
126+
relational joins.
130127
+++
131128
**What's inside:**
132-
Connectivity and integration options with database drivers
133-
and applications, libraries, and frameworks.
129+
CrateDB can do the same like Lotus Notes / Domino, CouchDB, MongoDB,
130+
and PostgreSQL's JSON data type.
134131
:::
135132

136133

137-
:::{grid-item-card} {material-outlined}`sync;2em` Import and Export
138-
:link: import-export
134+
:::{grid-item-card} {material-outlined}`manage_search;2em` Full-Text Search
135+
:link: fulltext
139136
:link-type: ref
140-
:link-alt: About time series data import and export
137+
:link-alt: About CrateDB's full-text search capabilities
141138

142-
Import data into and export data from your CrateDB cluster.
139+
Learn about CrateDB's Okapi BM25 implementation, how to set up your database
140+
for full-text search, and how to query text data efficiently, to make sense
141+
of large volumes of unstructured information.
143142
+++
144143
**What's inside:**
145-
A variety of options to connect and integrate with 3rd-party
146-
ETL applications.
144+
Like Elasticsearch, CrateDB is based on Lucene, the premier industry-grade
145+
full-text search engine library.
147146
:::
148147

149-
150148
::::
151-
152-
153-
```{include} /_include/styles.html
154-
```

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88

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

11+
:::{card} Introduction
12+
:link: all-features
13+
:link-type: ref
14+
15+
Start by reading about all features of CrateDB at a glance.
16+
:::
17+
1118
CrateDB is a distributed and scalable SQL database for storing and analyzing
1219
massive amounts of data in near real-time, even with complex queries. It is
1320
PostgreSQL-compatible, and based on Lucene.

0 commit comments

Comments
 (0)