-
Notifications
You must be signed in to change notification settings - Fork 1
Move "Getting started" to the root of the TOC #348
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
41ede2a
test
bmunkholm 203e73a
Merge branch 'main' into bm/move-getting-started-1
bmunkholm fa7c04f
Extracted Getting Started from Guides
bmunkholm 37bdb3d
Move overview
bmunkholm a3a9bed
Adjust required theme version.
bmunkholm 99f48f2
Merge remote-tracking branch 'origin/main' into bm/move-getting-start…
bmunkholm 6d34c79
Fixed accessibility hint for overview diagram.
bmunkholm fb52846
temporarily use dev0 version of theme for previewing
bmunkholm 9163295
Remove unused reference.
bmunkholm 5446196
Removed Getting Started from Guides, as it's been moved out 1 level
bmunkholm 3a0f51c
renamed guide to handbook
bmunkholm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,288 @@ | ||
(guides)= | ||
(howtos)= | ||
(tutorials)= | ||
(use-more-tutorials)= | ||
|
||
# Handbook | ||
|
||
Guides and tutorials about how to use CrateDB and CrateDB Cloud in practice. | ||
|
||
|
||
::::{grid} 4 | ||
:padding: 0 | ||
|
||
:::{grid-item-card} Installation | ||
:link: install | ||
:link-type: ref | ||
:link-alt: Installing CrateDB | ||
:padding: 1 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`download_for_offline;1.3em` | ||
::: | ||
|
||
|
||
:::{grid-item-card} Administration | ||
:link: administration | ||
:link-type: ref | ||
:link-alt: CrateDB Administration | ||
:padding: 1 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`auto_stories;1.3em` | ||
::: | ||
|
||
|
||
:::{grid-item-card} Performance Guides | ||
:link: performance | ||
:link-type: ref | ||
:link-alt: CrateDB Performance Guides | ||
:padding: 1 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`speed;1.3em` | ||
::: | ||
|
||
|
||
:::: | ||
|
||
|
||
## Features | ||
|
||
:::{rubric} Highlights | ||
::: | ||
|
||
::::{grid} 1 2 3 3 | ||
:padding: 0 | ||
|
||
:::{grid-item-card} Document Store | ||
:link: document | ||
:link-type: ref | ||
:link-alt: Storing JSON documents using CrateDB's `OBJECT` data type | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`article;1.3em` | ||
::: | ||
|
||
:::{grid-item-card} Search | ||
:link: search-overview | ||
:link-type: ref | ||
:link-alt: About CrateDB's search capabilities | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`manage_search;1.3em` | ||
::: | ||
|
||
:::{grid-item-card} Advanced Querying | ||
:link: advanced-querying | ||
:link-type: ref | ||
:link-alt: About CrateDB's advanced querying capabilities | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`engineering;1.3em` | ||
::: | ||
|
||
:::: | ||
|
||
:::{card} All features | ||
:link: all-features | ||
:link-type: ref | ||
|
||
CrateDB is a distributed and scalable SQL database for storing and analyzing | ||
massive amounts of data in near real-time, even with complex queries. It is | ||
based on Lucene, combines a unique set of features, and is PostgreSQL-compatible. | ||
|
||
 | ||
+++ | ||
Read about all features of CrateDB at a glance. | ||
::: | ||
|
||
|
||
## Data ingestion | ||
|
||
Load data into CrateDB. | ||
|
||
::::{grid} 1 2 3 3 | ||
:padding: 0 | ||
|
||
:::{grid-item-card} ETL | ||
:link: etl | ||
:link-type: ref | ||
:link-alt: Load and export data into/from CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`transform;1.3em` | ||
::: | ||
|
||
:::{grid-item-card} CDC | ||
:link: cdc | ||
:link-type: ref | ||
:link-alt: Change Data Capture (CDC) into CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`double_arrow;1.3em` | ||
::: | ||
|
||
:::{grid-item-card} Telemetry | ||
:link: telemetry | ||
:link-type: ref | ||
:link-alt: Use CrateDB with metrics collection agents, brokers, and stores | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`query_stats;1.3em` | ||
::: | ||
|
||
:::: | ||
|
||
|
||
## Solutions | ||
|
||
Learn how others are using CrateDB successfully. | ||
|
||
::::{grid} 1 2 3 3 | ||
:padding: 0 | ||
|
||
:::{grid-item-card} Solutions and use cases | ||
:link: solutions | ||
:link-type: ref | ||
:link-alt: Solutions built with CrateDB | ||
:padding: 1 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`lightbulb;1.3em` | ||
::: | ||
|
||
:::: | ||
|
||
|
||
## Topics | ||
|
||
Learn how to apply CrateDB's features to optimally cover use-cases across different | ||
application and topic domains, for example, by connecting CrateDB with third-party | ||
software applications, libraries, and frameworks. | ||
|
||
::::{grid} 1 2 3 3 | ||
:padding: 0 | ||
|
||
|
||
:::{grid-item-card} Business Intelligence | ||
:link: bi | ||
:link-type: ref | ||
:link-alt: Analyse information with CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`analytics;1.3em` | ||
::: | ||
|
||
:::{grid-item-card} Data Visualization | ||
:link: visualization | ||
:link-type: ref | ||
:link-alt: Data visualization with CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`bar_chart;1.3em` | ||
::: | ||
|
||
|
||
:::{grid-item-card} Machine Learning | ||
:link: machine-learning | ||
:link-type: ref | ||
:link-alt: Machine Learning with CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`model_training;1.3em` | ||
::: | ||
|
||
|
||
:::{grid-item-card} Software Testing | ||
:link: testing | ||
:link-type: ref | ||
:link-alt: Software testing with CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`integration_instructions;1.3em` | ||
::: | ||
|
||
|
||
:::{grid-item-card} Time Series Data | ||
:link: timeseries | ||
:link-type: ref | ||
:link-alt: Managing Time Series Data with CrateDB | ||
:padding: 3 | ||
:text-align: center | ||
:class-card: sd-pt-3 | ||
:class-body: sd-fs-1 | ||
:class-title: sd-fs-5 | ||
|
||
{material-outlined}`stacked_line_chart;1.3em` | ||
::: | ||
|
||
|
||
:::: | ||
|
||
|
||
```{toctree} | ||
:hidden: | ||
|
||
../install/index | ||
../connect/index | ||
../feature/index | ||
Ingestion <../ingest/index> | ||
../topic/index | ||
Solutions <../solution/index> | ||
../integrate/index | ||
../admin/index | ||
../performance/index | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you rename this to
handbook
, to accompany the other patch?