Skip to content
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

Refactoring, reshaping, and a bit of refurbishing #9

Merged
merged 5 commits into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions docs/admin/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,3 @@ A collection of CrateDB best practices and tips for common scenarios.

introduction
create-user
migrate/mysql
migrate/mongodb

File renamed without changes.
File renamed without changes.
33 changes: 26 additions & 7 deletions docs/handbook/index.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,38 @@
.. _handbook:
.. _handbooks:
.. _user-handbooks:

#########
Handbooks
#########
########
Handbook
########

A collection of CrateDB best practices and tips for common scenarios
around the topics of sharding, partitioning, and performance tuning.
This section of the documentation covers CrateDB database
administration practices.

.. rubric:: Table of contents
.. toctree::
:maxdepth: 1

bootstrap-checks
going-into-production
troubleshooting/index


Best practices and tips for common scenarios around the topics of
clustering, sharding, partitioning, and performance tuning.

.. toctree::
:maxdepth: 1

getting-started/index
clustering/index
sharding-partitioning
performance/index


Guidelines about upgrading CrateDB.

.. toctree::
:maxdepth: 1

upgrade/planning
upgrade/rolling
upgrade/full
File renamed without changes.
File renamed without changes.
File renamed without changes.
169 changes: 169 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
(index)=
(guides)=
(howtos)=
(tutorials)=

# CrateDB Guides and Tutorials

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
PostgreSQL-compatible, and based on Lucene.

This section of the documentation guides you how to use CrateDB in practice.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will swap the order of those two paragraphs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now even shorter:

About how to use CrateDB and CrateDB Cloud in practice.

/cc @matriv ⛑️



::::{grid} 3
:padding: 0


:::{grid-item-card} Installation
:link: install
:link-type: ref
:link-alt: Installing CrateDB
:padding: 3
: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} Getting Started
:link: getting-started
:link-type: ref
:link-alt: Getting started with CrateDB
:padding: 3
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5

{material-outlined}`rocket_launch;1.3em`
:::
Comment on lines +33 to +44
Copy link
Member Author

@amotl amotl Feb 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the 🚀 is too much here? Do you have any other suggestions?

Icons can be selected from https://fonts.google.com/icons. Sure enough, please also advise if you find better ones for the other tiles, as mentioned in the OP.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just make sure they are free to use :)

Copy link
Member Author

@amotl amotl Feb 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fine.
-- https://developers.google.com/fonts/faq


Frequently Asked Questions

Is there a cost for any of these fonts?

No, all Google Fonts are open source and are without cost.

Can I use any font in a commercial product?

Yes, you can use them commercially, and even include them within a product that is sold commercially. Usage and redistribution conditions are specified in the license. The most common license is the SIL Open Font License. Some fonts are under the Apache license or Ubuntu Font License. You can redistribute open source fonts according to those conditions.



:::{grid-item-card} Handbook
:link: handbook
:link-type: ref
:link-alt: CrateDB Handbook
:padding: 3
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5

{material-outlined}`auto_stories;1.3em`
:::


::::



## Reference Architectures

Reference architectures involving
CrateDB for various use-cases.
marijaselakovic marked this conversation as resolved.
Show resolved Hide resolved

::::{grid} 1
:padding: 0


:::{grid-item-card} Reference Architectures
:link: reference-architectures
:link-type: ref
:link-alt: Reference Architectures with CrateDB
:padding: 3
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5

![](https://cratedb.com/hs-fs/hubfs/nativesql.png?width=480&name=nativesql.png)

:::

::::




## Topics

Native features of CrateDB paired with auxiliary software components provide
optimal coverage of different application domains.
marijaselakovic marked this conversation as resolved.
Show resolved Hide resolved

::::{grid} 3
:padding: 0


:::{grid-item-card} Analysis and Visualization
:link: analysis
:link-type: ref
:link-alt: Data Analysis and 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}`analytics;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}`query_stats;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`
:::


::::



```{toctree}
:hidden:

install/index
getting-started/index
handbook/index
integrate/index

reference-architectures/index
t/analysis/index
t/timeseries/index
t/ml/index
```


:::{seealso}
CrateDB and its documentation are open source projects. We host the source code and
issue tracker on [GitHub].
:::


[GitHub]: https://github.com/crate/cratedb-guides
33 changes: 0 additions & 33 deletions docs/index.rst

This file was deleted.

29 changes: 29 additions & 0 deletions docs/integrate/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Integrations

A set of tutorials and guidelines how to integrate CrateDB with 3rd-party
systems.


```{toctree}
:maxdepth: 1

mongodb
mysql
```


```{toctree}
:maxdepth: 1

kafka-connect
azure-functions
streamsets
```


:::{tip}
Please also visit [Overview of CrateDB integration tutorials].
:::


[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we can work on the categorization similar to:
Screenshot 2024-02-13 at 17 24 28

Copy link
Member Author

@amotl amotl Feb 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I've diverted that over here.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _migrating-mongodb:

======================
Migrating from MongoDB
======================
========================
Import data from MongoDB
========================

.. rubric:: Table of contents

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _migrating-mysql:

====================
Migrating from MySQL
====================
======================
Import data from MySQL
======================

Various ways exist to migrate your existing data from MySQL_ to CrateDB_.
However, these methods may differ in performance. A fast and reliable way to
Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions docs/reference-architectures/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _reference-architectures:

=======================
Reference Architectures
=======================
Expand Down
20 changes: 2 additions & 18 deletions docs/t/timeseries/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _timeseries:

################
Time Series Data
################
Expand All @@ -13,21 +15,3 @@ tools, with respect to time-series use-cases.

generate/index
normalize-intervals


.. rubric:: Ingestion

.. toctree::
:maxdepth: 1

kafka-connect
streamsets


.. rubric:: Enrichment

.. toctree::
:maxdepth: 1

azure-functions

Loading