Skip to content

Commit 7b82b04

Browse files
committed
Getting started: Content. Layout. Shape.
1 parent e4a7573 commit 7b82b04

File tree

13 files changed

+705
-66
lines changed

13 files changed

+705
-66
lines changed

docs/start/applications.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
(sample-applications)=
2+
# Sample Applications
3+
4+
::::{grid}
5+
6+
:::{grid-item-card}
7+
:link: https://github.com/crate/crate-sample-apps
8+
A JavaScript guestbook app with a number of different backend implementations,
9+
each using a different client library to communicate with CrateDB.
10+
:::
11+
12+
::::

docs/start/connect.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Connect to cluster
1+
(start-connect)=
2+
# Connect to CrateDB
23

34
:::{include} /_include/links.md
45
:::

docs/start/create.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

docs/start/first-steps.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
description: >-
3+
This sections gives you some guidelines on how to get started quickly with
4+
CrateDB.
5+
---
6+
(first-steps)=
7+
# First steps with CrateDB
8+
9+
:::{div} sd-text-muted
10+
This section gives you some guidelines on how to get started quickly with CrateDB.
11+
:::
12+
13+
## 1. Create your first cluster
14+
15+
The fastest and easiest way to get started with CrateDB is by
16+
[creating a free CrateDB Cloud cluster][CrateDB Cloud Console].
17+
If you want to deploy CrateDB yourself, select the
18+
{ref}`on-premises <install>` or the {ref}`cloud-provider <install-cloud>`
19+
option.
20+
21+
## 2. Take a starter tutorial
22+
23+
Go through the interactive tutorials that best match your interests,
24+
or run them interactively from the CrateDB Cloud UI.
25+
26+
* **Working with JSON payloads?** • Analyze **marketing data**. • {{ '{}(#objects-basics)'.format(tutorial) }}
27+
28+
In this tutorial, explore the dynamic **OBJECT** data type to store and
29+
query complex, nested, multi-structured data from various platforms.
30+
You will also discover how to use generated columns to parse and manage
31+
URLs for deeper insights.
32+
33+
* **Interested in full-text search?** • Explore the **Netflix catalog**. • {{ '{}(#search-basics)'.format(tutorial) }}
34+
35+
In this tutorial, learn how to use CrateDB Cloud’s full-text search capabilities
36+
to work with large datasets and manage a collection of Netflix titles.
37+
38+
* **Exploring time-series data?** • Investigate **weather data**. • {{ '{}(#timeseries-querying)'.format(tutorial) }}
39+
40+
In this tutorial, you’ll work with weather readings from multiple locations
41+
to learn how to efficiently store and analyze time-series datasets.
42+
43+
## 3. Take an advanced tutorial
44+
45+
* **Analyze Device Readings with Metadata Integration** • {{ '{}(#timeseries-objects)'.format(tutorial) }}
46+
47+
In this tutorial, capture device metrics such as battery level, CPU usage,
48+
and memory, then enrich your time-series data with metadata (JSON, text)
49+
to enable more comprehensive analysis.
50+
51+
**Congratulations!**\
52+
You’re now onboarded and ready to explore further. Check out the other sections in the menu to dive deeper into CrateDB’s capabilities.
53+
54+
55+
56+
[check out our support plans]: https://cratedb.com/support/support-plans
57+
[CrateDB Cloud Console]: https://console.cratedb.cloud/

docs/start/going-further.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
(start-going-further)=
2+
# Going further
3+
4+
To learn more about CrateDB, we invite you to explore the other sections
5+
of the documentation portal.
6+
7+
:::::{card}
8+
9+
::::{sd-table}
10+
:widths: 4 8
11+
12+
:::{sd-row}
13+
```{sd-item} **Topic**
14+
```
15+
```{sd-item} **Description**
16+
```
17+
:::
18+
19+
:::{sd-row}
20+
```{sd-item} Data modelling
21+
:class: sd-font-weight-bolder
22+
```
23+
```{sd-item}
24+
Learn the different types of structured, semi-structured, and unstructured data.
25+
```
26+
:::
27+
28+
:::{sd-row}
29+
```{sd-item}
30+
:class: sd-font-weight-bolder
31+
{ref}`Query capabilities <query-capabilities>`
32+
```
33+
```{sd-item}
34+
Explore CrateDB’s key query capabilities, such as aggregations, ad-hoc queries,
35+
search and AI integration on large datasets at scale.
36+
```
37+
:::
38+
39+
:::{sd-row}
40+
```{sd-item}
41+
:class: sd-font-weight-bolder
42+
{ref}`Drivers <connect>`
43+
```
44+
```{sd-item}
45+
Connect CrateDB to your applications using official drivers. Also explore CrateDB CLIs.
46+
```
47+
:::
48+
49+
:::{sd-row}
50+
```{sd-item}
51+
:class: sd-font-weight-bolder sd-text-foreground
52+
{ref}`Integrations <integrate>`
53+
```
54+
```{sd-item}
55+
Use CrateDB with third-party adapters, connectors, data sources, and integrations.
56+
```
57+
:::
58+
59+
:::{sd-row}
60+
```{sd-item}
61+
:class: sd-font-weight-bolder
62+
{ref}`Reference manual <crate-reference:index>`
63+
```
64+
```{sd-item}
65+
Access the complete technical reference manual for CrateDB, and learn about
66+
its concepts and details.
67+
```
68+
:::
69+
70+
:::{sd-row}
71+
```{sd-item} Advanced guides
72+
:class: sd-font-weight-bolder
73+
```
74+
```{sd-item}
75+
Dive deeper into clustering concepts, reference architectures, installation, deployment, migration and upgrading.
76+
```
77+
:::
78+
79+
:::{sd-row}
80+
```{sd-item} Sample applications
81+
:class: sd-font-weight-bolder
82+
```
83+
```{sd-item}
84+
Explore ready-to-run sample projects that demonstrate how to build real-world solutions using CrateDB.
85+
```
86+
:::
87+
88+
:::{sd-row}
89+
```{sd-item}
90+
:class: sd-font-weight-bolder
91+
{ref}`Database management <administration>`
92+
```
93+
```{sd-item}
94+
Learn to manage your cluster with ease: configuration, sizing, performance tuning, cost optimization, monitoring and alerting, automation and REST API.
95+
```
96+
:::
97+
98+
:::{sd-row}
99+
```{sd-item}
100+
:class: sd-font-weight-bolder
101+
[Support and learning](https://learn.cratedb.com/)
102+
```
103+
```{sd-item}
104+
Get access to more resources to continue learning.
105+
```
106+
:::
107+
108+
::::
109+
110+
:::::

docs/start/index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@
55
```{toctree}
66
:maxdepth: 1
77
8-
create
8+
first-steps
99
connect
10-
schema
10+
going-further
11+
query/index
12+
applications
1113
Ingesting data <../ingest/index>
12-
query
1314
```
1415

1516

1617
:::{note}
1718
To learn more about all the details of CrateDB features, operations, and
18-
its SQL dialect, please also visit the [CrateDB Reference Manual].
19+
its SQL dialect, please also visit the [All Features] page and the
20+
[CrateDB Reference Manual].
1921
:::
2022

2123

24+
[All Features]: project:#features
2225
[CrateDB Reference Manual]: inv:crate-reference:*:label#index

docs/start/query.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)