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

Refactor "User Handbooks" section #4

Merged
merged 2 commits into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
5 changes: 4 additions & 1 deletion backlog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

- Add homepage with better guidance
- Add content from `crate-tutorials` at `/install`
- Add ML content from other patches and repositories
- ML: Add original content by PF
- ML: Add content from other patches and repositories
- Link to tutorials in community forum
- Backport high-quality content from community forum
- Update HTTP links, use Sphinx references instead
- Render Jupyter Notebooks?
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _getting-started:

###############
Getting Started
###############
Expand Down
10 changes: 7 additions & 3 deletions docs/handbook/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
########
Handbook
########
.. _handbooks:
.. _user-handbooks:

##############
User Handbooks
##############

A collection of CrateDB best practices and tips for common scenarios
around the topics of sharding, partitioning, and performance tuning.
Expand All @@ -10,6 +13,7 @@ around the topics of sharding, partitioning, and performance tuning.
.. toctree::
:maxdepth: 1

getting-started/index
sharding-partitioning
performance/index

19 changes: 7 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
.. _index:
.. _getting-started:
.. _guides:
.. _tutorials:

==============
CrateDB Guides
==============
############################
CrateDB Guides and Tutorials
############################

CrateDB is a distributed SQL database that makes it simple to store and analyze
massive amounts of machine data in real-time.

.. NOTE::

This resource assumes you know the basics. If not, check out the
`Tutorials`_ section for beginner material.

.. SEEALSO::

This is an open source documentation project. We host the source code and
Expand All @@ -24,14 +20,13 @@ massive amounts of machine data in real-time.
:maxdepth: 3
:titlesonly:

getting-started/index
admin/index
handbook/index
admin/index

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


.. _Tutorials: https://crate.io/docs/crate/tutorials/en/latest/
.. _GitHub: https://github.com/crate/cratedb-guides
3 changes: 3 additions & 0 deletions docs/t/analysis/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. _analysis:
.. _visualization:

###############################
Data Analysis and Visualization
###############################
Expand Down
9 changes: 6 additions & 3 deletions docs/t/ml/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#############################
Machine Learning with CrateDB
#############################
.. _ml:
.. _machine-learning:

################
Machine Learning
################

This section of the documentation covers integrations of CrateDB with machine
learning frameworks and tools.
Expand Down
6 changes: 3 additions & 3 deletions docs/t/timeseries/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#############################
Working with Time Series Data
#############################
################
Time Series Data
################

This section of the documentation covers integrations of CrateDB with other
tools, with respect to time-series use-cases.
Expand Down