Skip to content

Commit

Permalink
Refactoring: Add references to ex. Cloud tutorials to "Quick Start" page
Browse files Browse the repository at this point in the history
Based on the suggestion to add links to the end of the quick start page
instead of a separate page.
  • Loading branch information
amotl committed Aug 7, 2024
1 parent c83678f commit 0548d4a
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 91 deletions.
7 changes: 0 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,6 @@ A command-line based terminal program to operate your managed clusters.
:::


:::{grid-item-card} {octicon}`mortar-board` Tutorials
:link: usage
:link-type: ref
Learn how to use key features of CrateDB SQL.
:::

:::{grid-item-card} {octicon}`container` CrateDB Cloud on Kubernetes
:link: cloud-on-kubernetes
:link-type: ref
Expand Down Expand Up @@ -159,7 +153,6 @@ for improvements], and [source code contributions], are always welcome. {fab}`gi
:hidden:

Quick Start <tutorials/quick-start>
Usage <tutorials/usage>
Services <reference/services>
Billing <reference/billing>
Manage <howtos/index>
Expand Down
77 changes: 77 additions & 0 deletions docs/tutorials/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,80 @@ FROM nyc_taxi
LIMIT 100;
:::
::::


## Usage

Learn how to use key features of CrateDB SQL using fundamental tutorials,
or explore {ref}`guide:features`.


:::::{grid} auto 2 2 2
:margin: 4 4 0 0
:padding: 0
:gutter: 2

::::{grid-item-card} {material-outlined}`data_object;2em` Document Store: The OBJECT Data Type
:link: guide:objects-basics
:link-type: ref
:class-footer: text-smaller

CrateDB’s `OBJECT` data type allows to store and analyze complex and nested data
efficiently. It can optionally be strict or dynamic, thus schemaless.

The tutorial explores analyzing marketing data, therefore it also outlines another
feature of CrateDB, supporting destructuring URLs by using generated columns.
+++
CrateDB's document store is based on Lucene indexes, exactly how Elasticsearch
is doing it.
::::

::::{grid-item-card} {material-outlined}`topic;2em` Time Series: Device Readings with Metadata
:link: guide:timeseries-objects
:link-type: ref
:class-footer: text-smaller

CrateDB supports effective time series analysis with enhanced features
for fast aggregations.

- Rich data types for storing structured nested data (OBJECT) alongside
time series data.
- A rich set of built-in functions for aggregations.
- Relational JOIN operations.
- Common table expressions (CTEs).
+++
Combine time series data with document data: CrateDB is all you need.
::::

::::{grid-item-card} {material-outlined}`search;2em` Full-Text: Explore the Netflix Catalog
:link: guide:search-basics
:link-type: ref
:class-footer: text-smaller
CrateDB's `TEXT INDEX USING FULLTEXT` SQL DDL clause sets up a full-text index
on a column. The `MATCH` SQL predicate is used for querying it.

The tutorial explores the Netflix Catalog, exercising FTS features on relevant data.
+++
CrateDB's full-text search is based on Lucene's inverted index and BM25 scoring.
::::

::::{grid-item-card} {material-outlined}`lightbulb;2em` Time Series: Advanced SQL
:link: guide:timeseries-analysis-weather
:link-type: ref
:class-footer: text-smaller
CrateDB provides enhanced features for querying time series data.

Run aggregations with gap filling / interpolation, using common
table expressions (CTEs) and LAG / LEAD window functions.

Find maximum values using the MAX_BY aggregate function, returning
the value from one column based on the maximum or minimum value of another
column within a group.

The tutorial analyzes data from synoptic weather observations.
+++
Advanced queries on time series data: CrateDB is all you need.
::::


:::::
84 changes: 0 additions & 84 deletions docs/tutorials/usage.md

This file was deleted.

0 comments on commit 0548d4a

Please sign in to comment.