Skip to content

Commit 8946a4b

Browse files
committed
Refactoring / Naming things: Implement suggestions by CodeRabbit
1 parent eb266be commit 8946a4b

File tree

4 files changed

+49
-62
lines changed

4 files changed

+49
-62
lines changed

docs/index.md

Lines changed: 39 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,11 @@ Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice.
7272
::::
7373

7474

75-
:::{card} Introduction
76-
:link: all-features
77-
:link-type: ref
75+
## Features
7876

79-
CrateDB is a distributed and scalable SQL database for storing and analyzing
80-
massive amounts of data in near real-time, even with complex queries. It is
81-
based on Lucene, combines a unique set of features, and is PostgreSQL-compatible.
82-
83-
![](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png)
84-
+++
85-
Read about all features of CrateDB at a glance.
77+
:::{rubric} Highlights
8678
:::
8779

88-
89-
## Feature Highlights
90-
91-
A few selected features.
92-
9380
::::{grid} 1 2 3 3
9481
:padding: 0
9582

@@ -134,8 +121,21 @@ A few selected features.
134121

135122
::::
136123

124+
:::{card} All features
125+
:link: all-features
126+
:link-type: ref
137127

138-
## Data Ingestion
128+
CrateDB is a distributed and scalable SQL database for storing and analyzing
129+
massive amounts of data in near real-time, even with complex queries. It is
130+
based on Lucene, combines a unique set of features, and is PostgreSQL-compatible.
131+
132+
![](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=800&name=nativesql.png)
133+
+++
134+
Read about all features of CrateDB at a glance.
135+
:::
136+
137+
138+
## Data ingestion
139139

140140
Load data into CrateDB.
141141

@@ -184,6 +184,29 @@ Load data into CrateDB.
184184
::::
185185

186186

187+
## Solutions
188+
189+
Learn how others are using CrateDB successfully.
190+
191+
::::{grid} 1 2 3 3
192+
:padding: 0
193+
194+
:::{grid-item-card} Solutions and use cases
195+
:link: solutions
196+
:link-type: ref
197+
:link-alt: Solutions built with CrateDB
198+
:padding: 1
199+
:text-align: center
200+
:class-card: sd-pt-3
201+
:class-body: sd-fs-1
202+
:class-title: sd-fs-5
203+
204+
{material-outlined}`lightbulb;1.3em`
205+
:::
206+
207+
::::
208+
209+
187210
## Topics
188211

189212
Learn how to apply CrateDB's features to optimally cover use-cases across different
@@ -266,43 +289,6 @@ software applications, libraries, and frameworks.
266289
::::
267290

268291

269-
## Use Cases
270-
271-
Selected application domains where others are using CrateDB successfully.
272-
273-
::::{grid} 1 2 3 3
274-
:padding: 0
275-
276-
277-
:::{grid-item-card} Raw-Data Analytics
278-
:link: analytics
279-
:link-type: ref
280-
:link-alt: CrateDB in tracking and analytics scenarios
281-
:padding: 3
282-
:text-align: center
283-
:class-card: sd-pt-3
284-
:class-body: sd-fs-1
285-
:class-title: sd-fs-5
286-
287-
{material-outlined}`analytics;1.3em`
288-
:::
289-
290-
:::{grid-item-card} Industrial Data
291-
:link: industrial
292-
:link-type: ref
293-
:link-alt: CrateDB in industrial / IIoT / Industry 4.0 scenarios
294-
:padding: 3
295-
:text-align: center
296-
:class-card: sd-pt-3
297-
:class-body: sd-fs-1
298-
:class-title: sd-fs-5
299-
300-
{material-outlined}`precision_manufacturing;1.3em`
301-
:::
302-
303-
::::
304-
305-
306292

307293
```{toctree}
308294
:hidden:

docs/ingest/telemetry/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
CrateDB works well for storing massive amounts of telemetry data, such as metrics and logs.
1818

19-
It is a spiritual successor, or alternative to, rrdtool, Graphite, InfluxDB, Prometheus,
20-
Mimir, or Thanos, but with the benefits of long term storage capabilities, standard
21-
database interfaces, SQL query language, and horizontal scalability as you go.
19+
CrateDB can serve as an alternative to tools like rrdtool, Graphite, InfluxDB,
20+
Prometheus, Mimir, or Thanos, while adding longterm storage, standard database
21+
interfaces, SQL, and horizontal scalability.
2222

2323
CrateDB integrates with metrics collection agents, brokers, and stores.
2424
This documentation section lists applications and daemons which can
@@ -53,14 +53,14 @@ scenarios. CrateDB offers corresponding integration adapters.
5353
:gutter: 2
5454

5555
::::{grid-item-card} Prometheus
56-
:link: fulltext-search
56+
:link: prometheus
5757
:link-type: ref
5858
Prometheus is an open-source systems monitoring and alerting toolkit
5959
for collecting metrics data from applications and infrastructures.
6060
::::
6161

6262
::::{grid-item-card} Telegraf
63-
:link: geo-search
63+
:link: telegraf
6464
:link-type: ref
6565
Telegraf is a leading open source server agent to help you collect metrics
6666
from your stacks, sensors, and systems.

docs/solution/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
(use-cases)=
2+
(solutions)=
23
# Solutions and use cases
34

45
CrateDB is being developed in an open-source spirit, and closely together
@@ -12,7 +13,7 @@ build real-time data management and analytics solutions and platforms.
1213
:gutter: 2
1314

1415

15-
:::{grid-item-card} {material-outlined}`search;2em` Fulltext and semantic search
16+
:::{grid-item-card} {material-outlined}`search;2em` Full-text and semantic search
1617
:link: search-overview
1718
:link-type: ref
1819
:link-alt: About CrateDB's search features

docs/solution/industrial/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,9 @@ ensure real-time production quality control.
147147
CrateDB helps Rauch to identify and predict production issues and gives access
148148
to production data for many years, with no need for additional infrastructure.
149149

150-
Rauch is filling 33 cans per second and how that adds up to 400 data records
151-
per second which are being processed, stored, and analyzed. In total, they are
152-
within the range of one to ten billion records persisted in CrateDB.
150+
Rauch fills 33 cans per second, which adds up to 400 data records per second
151+
that are processed, stored, and analyzed. In total, they are within the range
152+
of one to ten billion records persisted in CrateDB.
153153

154154
- [Rauch: High-Speed Production Lines]
155155

0 commit comments

Comments
 (0)