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

Rename from "howtos" to "guides" #1

Merged
merged 5 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
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python: "3.11"

sphinx:
builder: html
Expand Down
70 changes: 0 additions & 70 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -175,73 +175,3 @@
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


===============================================================================

For the `docs` directory:

The source files for the documentation are licensed under the Apache License
Version 2.0. These source files are used by the project maintainers to build
online documentation for end-users:

<https://crate.io/docs/crate/guide/en/latest/>

If you want to make contributions to the documentation, it may be necessary for
you to build the documentation yourself by following the instructions in the
`DEVELOP.rst` file. If you do this, a number of third-party software components
are necessary.

We do not ship the source code for these optional third-party software
components or their dependencies, so we cannot make any guarantees about the
licensing status of these components.

However, for convenience, the documentation build system explicitly references
the following software components (grouped by license):

PSF License:

- Python 3 <https://docs.python.org/3/license.html>

MIT License:

- pip <https://pypi.org/project/pip/>
- setuptools <https://pypi.org/project/setuptools/>
- sphinx-autobuild <https://pypi.org/project/sphinx-autobuild/>

BSD License:

- alabaster <https://pypi.org/project/alabaster/>
- sphinx <https://pypi.org/project/Sphinx/>

Apache License 2.0:

- crate-docs-theme <https://pypi.org/project/crate-docs-theme/>

Please note that each of these components may specify its own dependencies and
those dependencies may be licensed differently.
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
CrateDB Guide
Copyright 2017 Crate.IO GmbH ("Crate")
Copyright 2017-2023 Crate.IO GmbH ("Crate")

Licensed to Crate.IO GmbH (referred to in this notice as "Crate") under one or
more contributor license agreements.
Expand Down
26 changes: 13 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
=====================
CrateDB How-To Guides
=====================
==============
CrateDB Guides
==============

|ci| |rtd| |build|

How-to guides for CrateDB_.
Guidelines, handbooks, and cookbooks for CrateDB_.

Contributing
============
Expand All @@ -23,22 +23,22 @@ Looking for more help?
- Check out our `support channels`_

.. _contribution docs: CONTRIBUTING.rst
.. _Crate.io: http://crate.io/
.. _Crate.io: https://cratedb.com/
.. _CrateDB: https://github.com/crate/crate
.. _developer docs: DEVELOP.rst
.. _project docs: https://crate.io/docs/crate/howtos/en/latest/
.. _support channels: https://crate.io/support/
.. _project docs: https://cratedb.com/docs/guide/en/latest/
.. _support channels: https://cratedb.com/support/


.. |ci| image:: https://github.com/crate/crate-howtos/actions/workflows/docs.yml/badge.svg
.. |ci| image:: https://github.com/crate/cratedb-guides/actions/workflows/docs.yml/badge.svg
:alt: CI status
:scale: 100%
:target: https://github.com/crate/crate-howtos/actions/workflows/docs.yml
:target: https://github.com/crate/cratedb-guides/actions/workflows/docs.yml

.. |rtd| image:: https://readthedocs.org/projects/crate-howtos/badge/?version=latest
.. |rtd| image:: https://readthedocs.org/projects/cratedb-guides/badge/?version=latest
:alt: Read The Docs status
:target: https://readthedocs.org/projects/crate-howtos
:target: https://readthedocs.org/projects/cratedb-guides

.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcrate-howtos%2Fmaster%2Fdocs%2Fbuild.json
.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcratedb-guides%2Fmaster%2Fdocs%2Fbuild.json
:alt: Build version
:target: https://github.com/crate/crate-howtos/blob/master/docs/build.json
:target: https://github.com/crate/cratedb-guides/blob/master/docs/build.json
Binary file added docs/_assets/img/getting-started/create-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/img/integrations/azfunc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/img/integrations/kafka-connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/img/integrations/powerbi-source.png
Binary file added docs/_assets/img/integrations/r-iris-features.png
Binary file added docs/_assets/img/multi-node-cluster.png
2 changes: 1 addition & 1 deletion docs/_extra/robots.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
User-agent: *
Disallow: /

Sitemap: https://crate.io/docs/crate/howtos/site.xml
Sitemap: https://cratedb.com/docs/guide/site.xml
2 changes: 1 addition & 1 deletion docs/build.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"schemaVersion": 1,
"label": "docs build",
"message": "2.1.0"
"message": "2.1.1"
}
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from crate.theme.rtd.conf.crate_howtos import *
from crate.theme.rtd.conf.cratedb_guides import *

linkcheck_ignore = [
# Forbidden by WordPress
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/create-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Grant all privileges to the newly created user:

cr> GRANT ALL PRIVILEGES TO username;

.. image:: _assets/img/create-user.png
.. image:: /_assets/img/getting-started/create-user.png

Now try navigating to the :ref:`crate-admin-ui:index` in your browser. In the URL
below, please replace ``cratedb.example.org`` with the host name or IP address
Expand All @@ -62,7 +62,7 @@ account::

You should see something like this:

.. image:: _assets/img/first-use/admin-ui.png
.. image:: /_assets/img/getting-started/first-use/admin-ui.png


After creating the user and granting all privileges, you should be able to
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/first-use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ CrateDB is running on.

You should see something like this:

.. image:: _assets/img/first-use/admin-ui.png
.. image:: /_assets/img/getting-started/first-use/admin-ui.png


.. _use-crash:
Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/generate-time-series/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ load averages.
In the :ref:`crate-admin-ui:index`, you should see the new table when you navigate
to the *Tables* screen using the left-hand navigation menu:

.. image:: ../_assets/img/generate-time-series/table.png
.. image:: /_assets/img/getting-started/generate-time-series/table.png


Record the ISS position
Expand Down Expand Up @@ -269,14 +269,14 @@ Run it from the command line, like so:

As this runs, you should see the table filling up in the CrateDB Admin UI:

.. image:: ../_assets/img/generate-time-series/rows.png
.. image:: /_assets/img/getting-started/generate-time-series/rows.png

Lots of freshly generated time series data, ready for use.

And, for bonus points, if you select the arrow next to the location data, it
will open up a map view showing the current position of the ISS:

.. image:: ../_assets/img/generate-time-series/map.png
.. image:: /_assets/img/getting-started/generate-time-series/map.png

.. TIP::

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/generate-time-series/go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ containing the `pgx`_ package and add it to ``go.mod``.
In the :ref:`crate-admin-ui:index`, you should see the new table when you navigate
to the *Tables* screen using the left-hand navigation menu:

.. image:: ../_assets/img/generate-time-series/table.png
.. image:: /_assets/img/getting-started/generate-time-series/table.png


Record the ISS position
Expand Down Expand Up @@ -401,14 +401,14 @@ Run the script from the command line:
As the script runs, you should see the table filling up in the
:ref:`crate-admin-ui:index`.

.. image:: ../_assets/img/generate-time-series/rows.png
.. image:: /_assets/img/getting-started/generate-time-series/rows.png

Lots of freshly generated time series data, ready for use.

And, for bonus points, if you select the arrow next to the location data, it
will open up a map view showing the current position of the ISS:

.. image:: ../_assets/img/generate-time-series/map.png
.. image:: /_assets/img/getting-started/generate-time-series/map.png

.. TIP::

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/generate-time-series/node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Success!
In the :ref:`crate-admin-ui:index`, you should see the new table when you navigate to
the *Tables* screen using the left-hand navigation menu:

.. image:: ../_assets/img/generate-time-series/table.png
.. image:: /_assets/img/getting-started/generate-time-series/table.png


Record the ISS position
Expand Down Expand Up @@ -323,14 +323,14 @@ Run the script from the command line:
As the script runs, you should see the table filling up in the CrateDB Admin
UI:

.. image:: ../_assets/img/generate-time-series/rows.png
.. image:: /_assets/img/getting-started/generate-time-series/rows.png

Lots of freshly generated time series data, ready for use.

And, for bonus points, if you select the arrow next to the location data, it
will open up a map view showing the current position of the ISS:

.. image:: ../_assets/img/generate-time-series/map.png
.. image:: /_assets/img/getting-started/generate-time-series/map.png

.. TIP::

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/generate-time-series/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ ISS position coordinates.
In the :ref:`crate-admin-ui:index`, you should see the new table when you navigate to
the *Tables* screen using the left-hand navigation menu:

.. image:: ../_assets/img/generate-time-series/table.png
.. image:: /_assets/img/getting-started/generate-time-series/table.png


Record the ISS position
Expand Down Expand Up @@ -222,14 +222,14 @@ Run the script from the command line, like so:
As the script runs, you should see the table filling up in the CrateDB Admin
UI:

.. image:: ../_assets/img/generate-time-series/rows.png
.. image:: /_assets/img/getting-started/generate-time-series/rows.png

Lots of freshly generated time series data, ready for use.

And, for bonus points, if you select the arrow next to the location data, it
will open up a map view showing the current position of the ISS:

.. image:: ../_assets/img/generate-time-series/map.png
.. image:: /_assets/img/getting-started/generate-time-series/map.png

.. TIP::

Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started/normalize-intervals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Normalize time series data intervals

.. sidebar:: The ISS Orbit

.. image:: _assets/img/normalize-intervals/orbit.gif
:alt: An animated visualization of the ISS orbit
.. image:: /_assets/img/getting-started/normalize-intervals/orbit.png
:alt: A visualization of the ISS orbit
:target: https://en.wikipedia.org/wiki/International_Space_Station#Orbit

The ISS travels at 27,724 kilometers per hour and orbits Earth
Expand Down Expand Up @@ -122,7 +122,7 @@ the top right-hand corner), then *Notebook* → *Python 3*.
Type your Python code at the input prompt. Then, select *Run* (Shift-Enter ⇧⏎)
to evaluate the code:

.. image:: _assets/img/normalize-intervals/jupyter-hello-world.png
.. image:: /_assets/img/getting-started/normalize-intervals/jupyter-hello-world.png

You can re-evaluate input blocks as many times as you like.

Expand Down Expand Up @@ -367,7 +367,7 @@ You can test the ``plot()`` function by passing in the return value of

Jupyter should display a plot like this:

.. image:: _assets/img/normalize-intervals/raw-data.png
.. image:: /_assets/img/getting-started/normalize-intervals/raw-data.png

Above, notice that:

Expand Down Expand Up @@ -490,7 +490,7 @@ You can plot this data like before:

plot(data_by_minute())

.. image:: _assets/img/normalize-intervals/data-by-minute.png
.. image:: /_assets/img/getting-started/normalize-intervals/data-by-minute.png

Here, notice that the individual data points are now visible (i.e., the
apparent line in the previous diagram is now discernible as a series of
Expand Down Expand Up @@ -662,7 +662,7 @@ Plot the data:

plot(null_by_minute_24h())

.. image:: _assets/img/normalize-intervals/null-by-minute-24h.png
.. image:: /_assets/img/getting-started/normalize-intervals/null-by-minute-24h.png

This plot displays null values for a full 24 hour period.

Expand Down Expand Up @@ -748,11 +748,11 @@ Plot the data:

plot(data_24h())

.. image:: _assets/img/normalize-intervals/data-24h.png
.. image:: /_assets/img/getting-started/normalize-intervals/data-24h.png

And here's what it looks like if you wait a few more hours:

.. image:: _assets/img/normalize-intervals/data-24h-more.png
.. image:: /_assets/img/getting-started/normalize-intervals/data-24h-more.png

The finished result is a visualization that uses time series normalization and
resamples raw data to regular intervals with the interpolation of missing values.
Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _index:

=====================
CrateDB How-To Guides
=====================
==============
CrateDB Guides
==============

CrateDB is a distributed SQL database that makes it simple to store and analyze
massive amounts of machine data in real-time.
Expand Down Expand Up @@ -35,4 +35,4 @@ massive amounts of machine data in real-time.


.. _Tutorials: https://crate.io/docs/crate/tutorials/en/latest/
.. _GitHub: https://github.com/crate/crate-howtos
.. _GitHub: https://github.com/crate/cratedb-guides
2 changes: 1 addition & 1 deletion docs/integrations/azure-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ new data flowing into an IoT Hub.

.. _figure_1:

.. figure:: azfunc.png
.. figure:: /_assets/img/integrations/azfunc.png
:align: center

An Azure Function is a short-lived, serverless computation that is triggered
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/kafka-connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This results in the following architecture:

.. _figure_1:

.. figure:: kafka-connect.png
.. figure:: /_assets/img/integrations/kafka-connect.png
:align: center


Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/ml-dist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ successive epochs by stopping training, using the ``EarlyStopping`` callback.
plt.plot(hist.history["loss"])
plt.show()

.. figure:: mlp_model_train_loss.png
.. figure:: /_assets/img/integrations/mlp_model_train_loss.png
:align: left

This figure shows us the loss of each epoch. In the first 200 epochs it is
Expand Down
Loading