-
Notifications
You must be signed in to change notification settings - Fork 1
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7410ee1
Integrate: Add dedicated "Integrations" section
amotl 302cbac
Refactoring: Bring "getting started" to first level directory
amotl b05cace
Refactoring: Establish "Handbook" section
amotl 4b8f25f
Redesign: New main index page. Tiles everywhere!
amotl fa976d9
Redesign: Wording improvements on "home" page
amotl 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
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains 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 |
---|---|---|
@@ -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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains 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,174 @@ | ||
(index)= | ||
(guides)= | ||
(howtos)= | ||
(tutorials)= | ||
|
||
# CrateDB Guides and Tutorials | ||
|
||
About how to use CrateDB and CrateDB Cloud in practice. | ||
|
||
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. | ||
|
||
|
||
::::{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` | ||
::: | ||
|
||
|
||
:::{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 illustrating how CrateDB can be used in a variety of | ||
use-cases. | ||
|
||
::::{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 | ||
|
||
 | ||
|
||
::: | ||
|
||
:::: | ||
|
||
|
||
|
||
|
||
## Application Domains | ||
|
||
Native features of CrateDB paired with auxiliary software components provide | ||
optimal coverage of different application domains. | ||
|
||
::::{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 | ||
``` | ||
|
||
|
||
:::{tip} | ||
Please also visit the [Overview of CrateDB integration tutorials]. | ||
::: | ||
|
||
:::{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 | ||
[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015 |
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains 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,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 the [Overview of CrateDB integration tutorials]. | ||
::: | ||
|
||
|
||
[Overview of CrateDB integration tutorials]: https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks. I've diverted that over here. |
File renamed without changes.
This file contains 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
This file contains 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
File renamed without changes.
This file contains 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 |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _reference-architectures: | ||
|
||
======================= | ||
Reference Architectures | ||
======================= | ||
|
This file contains 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.
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.
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.
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.
Let's just make sure they are free to use :)
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.
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.