diff --git a/.readthedocs.yml b/.readthedocs.yml index 2cf5046f..a9437a2c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -3,7 +3,7 @@ version: 2 build: os: "ubuntu-22.04" tools: - python: "3.10" + python: "3.11" sphinx: builder: html diff --git a/LICENSE b/LICENSE index 7a8c8814..f433b1a5 100644 --- a/LICENSE +++ b/LICENSE @@ -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: - - - -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 - -MIT License: - - - pip - - setuptools - - sphinx-autobuild - -BSD License: - - - alabaster - - sphinx - -Apache License 2.0: - - - crate-docs-theme - -Please note that each of these components may specify its own dependencies and -those dependencies may be licensed differently. diff --git a/NOTICE b/NOTICE index b8850388..1765a820 100644 --- a/NOTICE +++ b/NOTICE @@ -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. diff --git a/README.rst b/README.rst index 20462165..2688096c 100644 --- a/README.rst +++ b/README.rst @@ -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 ============ @@ -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 diff --git a/docs/_assets/img/getting-started/create-user.png b/docs/_assets/img/getting-started/create-user.png new file mode 100644 index 00000000..af71235d Binary files /dev/null and b/docs/_assets/img/getting-started/create-user.png differ diff --git a/docs/_assets/img/getting-started/first-use/admin-ui.png b/docs/_assets/img/getting-started/first-use/admin-ui.png new file mode 100644 index 00000000..c9dfcfdc Binary files /dev/null and b/docs/_assets/img/getting-started/first-use/admin-ui.png differ diff --git a/docs/_assets/img/getting-started/generate-time-series/map.png b/docs/_assets/img/getting-started/generate-time-series/map.png new file mode 100644 index 00000000..d1255421 Binary files /dev/null and b/docs/_assets/img/getting-started/generate-time-series/map.png differ diff --git a/docs/_assets/img/getting-started/generate-time-series/rows.png b/docs/_assets/img/getting-started/generate-time-series/rows.png new file mode 100644 index 00000000..9a2a1e68 Binary files /dev/null and b/docs/_assets/img/getting-started/generate-time-series/rows.png differ diff --git a/docs/_assets/img/getting-started/generate-time-series/table.png b/docs/_assets/img/getting-started/generate-time-series/table.png new file mode 100644 index 00000000..740b9561 Binary files /dev/null and b/docs/_assets/img/getting-started/generate-time-series/table.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/data-24h-more.png b/docs/_assets/img/getting-started/normalize-intervals/data-24h-more.png new file mode 100644 index 00000000..2d3ad336 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/data-24h-more.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/data-24h.png b/docs/_assets/img/getting-started/normalize-intervals/data-24h.png new file mode 100644 index 00000000..9297c1e0 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/data-24h.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/data-by-minute.png b/docs/_assets/img/getting-started/normalize-intervals/data-by-minute.png new file mode 100644 index 00000000..92639e95 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/data-by-minute.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/jupyter-hello-world.png b/docs/_assets/img/getting-started/normalize-intervals/jupyter-hello-world.png new file mode 100644 index 00000000..b259a5d8 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/jupyter-hello-world.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/null-by-minute-24h.png b/docs/_assets/img/getting-started/normalize-intervals/null-by-minute-24h.png new file mode 100644 index 00000000..fcfaf831 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/null-by-minute-24h.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/orbit.png b/docs/_assets/img/getting-started/normalize-intervals/orbit.png new file mode 100644 index 00000000..0dadc940 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/orbit.png differ diff --git a/docs/_assets/img/getting-started/normalize-intervals/raw-data.png b/docs/_assets/img/getting-started/normalize-intervals/raw-data.png new file mode 100644 index 00000000..a24a57b5 Binary files /dev/null and b/docs/_assets/img/getting-started/normalize-intervals/raw-data.png differ diff --git a/docs/_assets/img/integrations/azfunc.png b/docs/_assets/img/integrations/azfunc.png new file mode 100644 index 00000000..0edc3e89 Binary files /dev/null and b/docs/_assets/img/integrations/azfunc.png differ diff --git a/docs/_assets/img/integrations/kafka-connect.png b/docs/_assets/img/integrations/kafka-connect.png new file mode 100644 index 00000000..f40e5fa1 Binary files /dev/null and b/docs/_assets/img/integrations/kafka-connect.png differ diff --git a/docs/_assets/img/integrations/mlp_model_train_loss.png b/docs/_assets/img/integrations/mlp_model_train_loss.png new file mode 100644 index 00000000..6e985ba9 Binary files /dev/null and b/docs/_assets/img/integrations/mlp_model_train_loss.png differ diff --git a/docs/_assets/img/integrations/powerbi-connection-successful.png b/docs/_assets/img/integrations/powerbi-connection-successful.png new file mode 100644 index 00000000..ec0539fb Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-connection-successful.png differ diff --git a/docs/_assets/img/integrations/powerbi-crate-dsn.png b/docs/_assets/img/integrations/powerbi-crate-dsn.png new file mode 100644 index 00000000..9748807f Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-crate-dsn.png differ diff --git a/docs/_assets/img/integrations/powerbi-driver-select.png b/docs/_assets/img/integrations/powerbi-driver-select.png new file mode 100644 index 00000000..9d229e0f Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-driver-select.png differ diff --git a/docs/_assets/img/integrations/powerbi-dsn-setup.png b/docs/_assets/img/integrations/powerbi-dsn-setup.png new file mode 100644 index 00000000..8fca90c4 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-dsn-setup.png differ diff --git a/docs/_assets/img/integrations/powerbi-gateway-clusters.png b/docs/_assets/img/integrations/powerbi-gateway-clusters.png new file mode 100644 index 00000000..b373d96f Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-gateway-clusters.png differ diff --git a/docs/_assets/img/integrations/powerbi-gateway-connection.png b/docs/_assets/img/integrations/powerbi-gateway-connection.png new file mode 100644 index 00000000..d77e6fba Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-gateway-connection.png differ diff --git a/docs/_assets/img/integrations/powerbi-gateway-status.png b/docs/_assets/img/integrations/powerbi-gateway-status.png new file mode 100644 index 00000000..576cf2bc Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-gateway-status.png differ diff --git a/docs/_assets/img/integrations/powerbi-manage-gateways.png b/docs/_assets/img/integrations/powerbi-manage-gateways.png new file mode 100644 index 00000000..a22d96fc Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-manage-gateways.png differ diff --git a/docs/_assets/img/integrations/powerbi-pie-chart.png b/docs/_assets/img/integrations/powerbi-pie-chart.png new file mode 100644 index 00000000..e0726ac4 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-pie-chart.png differ diff --git a/docs/_assets/img/integrations/powerbi-postgres-drivers.png b/docs/_assets/img/integrations/powerbi-postgres-drivers.png new file mode 100644 index 00000000..190680b4 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-postgres-drivers.png differ diff --git a/docs/_assets/img/integrations/powerbi-publish-destination.png b/docs/_assets/img/integrations/powerbi-publish-destination.png new file mode 100644 index 00000000..823de927 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-publish-destination.png differ diff --git a/docs/_assets/img/integrations/powerbi-publish-success.png b/docs/_assets/img/integrations/powerbi-publish-success.png new file mode 100644 index 00000000..e56c9b9f Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-publish-success.png differ diff --git a/docs/_assets/img/integrations/powerbi-published-report.png b/docs/_assets/img/integrations/powerbi-published-report.png new file mode 100644 index 00000000..e3c9211e Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-published-report.png differ diff --git a/docs/_assets/img/integrations/powerbi-refresh-in-progress.png b/docs/_assets/img/integrations/powerbi-refresh-in-progress.png new file mode 100644 index 00000000..debd13d0 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-refresh-in-progress.png differ diff --git a/docs/_assets/img/integrations/powerbi-refresh-now.png b/docs/_assets/img/integrations/powerbi-refresh-now.png new file mode 100644 index 00000000..5510e2fb Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-refresh-now.png differ diff --git a/docs/_assets/img/integrations/powerbi-refreshed-report.png b/docs/_assets/img/integrations/powerbi-refreshed-report.png new file mode 100644 index 00000000..38b6c086 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-refreshed-report.png differ diff --git a/docs/_assets/img/integrations/powerbi-schedule-refresh.png b/docs/_assets/img/integrations/powerbi-schedule-refresh.png new file mode 100644 index 00000000..d5275fb1 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-schedule-refresh.png differ diff --git a/docs/_assets/img/integrations/powerbi-source.png b/docs/_assets/img/integrations/powerbi-source.png new file mode 100644 index 00000000..bc0934ec Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-source.png differ diff --git a/docs/_assets/img/integrations/powerbi-start-menu.png b/docs/_assets/img/integrations/powerbi-start-menu.png new file mode 100644 index 00000000..2556e427 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-start-menu.png differ diff --git a/docs/_assets/img/integrations/powerbi-table-navigator.png b/docs/_assets/img/integrations/powerbi-table-navigator.png new file mode 100644 index 00000000..1a0edc46 Binary files /dev/null and b/docs/_assets/img/integrations/powerbi-table-navigator.png differ diff --git a/docs/_assets/img/integrations/r-iris-features.png b/docs/_assets/img/integrations/r-iris-features.png new file mode 100644 index 00000000..09f04670 Binary files /dev/null and b/docs/_assets/img/integrations/r-iris-features.png differ diff --git a/docs/_assets/img/integrations/streamsets-directory-files.png b/docs/_assets/img/integrations/streamsets-directory-files.png new file mode 100644 index 00000000..d343577e Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-directory-files.png differ diff --git a/docs/_assets/img/integrations/streamsets-directory-format.png b/docs/_assets/img/integrations/streamsets-directory-format.png new file mode 100644 index 00000000..79ca1d78 Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-directory-format.png differ diff --git a/docs/_assets/img/integrations/streamsets-field-type-conversions.png b/docs/_assets/img/integrations/streamsets-field-type-conversions.png new file mode 100644 index 00000000..e79626ae Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-field-type-conversions.png differ diff --git a/docs/_assets/img/integrations/streamsets-jdbc-driver.png b/docs/_assets/img/integrations/streamsets-jdbc-driver.png new file mode 100644 index 00000000..ecb27d16 Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-jdbc-driver.png differ diff --git a/docs/_assets/img/integrations/streamsets-jdbc-producer-credentials.png b/docs/_assets/img/integrations/streamsets-jdbc-producer-credentials.png new file mode 100644 index 00000000..80d1e194 Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-jdbc-producer-credentials.png differ diff --git a/docs/_assets/img/integrations/streamsets-jdbc-producer-settings.png b/docs/_assets/img/integrations/streamsets-jdbc-producer-settings.png new file mode 100644 index 00000000..27dfa5f9 Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-jdbc-producer-settings.png differ diff --git a/docs/_assets/img/integrations/streamsets-new-pipeline.png b/docs/_assets/img/integrations/streamsets-new-pipeline.png new file mode 100644 index 00000000..99b3fd5b Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-new-pipeline.png differ diff --git a/docs/_assets/img/integrations/streamsets-pipeline.png b/docs/_assets/img/integrations/streamsets-pipeline.png new file mode 100644 index 00000000..95e70b96 Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-pipeline.png differ diff --git a/docs/_assets/img/integrations/streamsets-running-pipeline.png b/docs/_assets/img/integrations/streamsets-running-pipeline.png new file mode 100644 index 00000000..faf15c8d Binary files /dev/null and b/docs/_assets/img/integrations/streamsets-running-pipeline.png differ diff --git a/docs/_assets/img/multi-node-cluster.png b/docs/_assets/img/multi-node-cluster.png new file mode 100644 index 00000000..f68167dc Binary files /dev/null and b/docs/_assets/img/multi-node-cluster.png differ diff --git a/docs/_assets/img/reference-architectures/cratedb-azure-iot.png b/docs/_assets/img/reference-architectures/cratedb-azure-iot.png new file mode 100644 index 00000000..36ab092b Binary files /dev/null and b/docs/_assets/img/reference-architectures/cratedb-azure-iot.png differ diff --git a/docs/_assets/img/reference-architectures/distributed-ml.png b/docs/_assets/img/reference-architectures/distributed-ml.png new file mode 100644 index 00000000..174201fb Binary files /dev/null and b/docs/_assets/img/reference-architectures/distributed-ml.png differ diff --git a/docs/_extra/robots.txt b/docs/_extra/robots.txt index 9be99188..2fb3aa58 100644 --- a/docs/_extra/robots.txt +++ b/docs/_extra/robots.txt @@ -1,4 +1,4 @@ User-agent: * Disallow: / -Sitemap: https://crate.io/docs/crate/howtos/site.xml +Sitemap: https://cratedb.com/docs/guide/site.xml diff --git a/docs/build.json b/docs/build.json index 49cbd2be..5647caf4 100644 --- a/docs/build.json +++ b/docs/build.json @@ -1,5 +1,5 @@ { "schemaVersion": 1, "label": "docs build", - "message": "2.1.0" + "message": "2.1.1" } diff --git a/docs/conf.py b/docs/conf.py index 57e75cac..0b0d468a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/getting-started/create-user.rst b/docs/getting-started/create-user.rst index f868dd67..de1b15f6 100644 --- a/docs/getting-started/create-user.rst +++ b/docs/getting-started/create-user.rst @@ -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 @@ -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 diff --git a/docs/getting-started/first-use.rst b/docs/getting-started/first-use.rst index a0214d2c..594fff08 100644 --- a/docs/getting-started/first-use.rst +++ b/docs/getting-started/first-use.rst @@ -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: diff --git a/docs/getting-started/generate-time-series/cli.rst b/docs/getting-started/generate-time-series/cli.rst index d40cb68c..7dc7c5c5 100644 --- a/docs/getting-started/generate-time-series/cli.rst +++ b/docs/getting-started/generate-time-series/cli.rst @@ -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 @@ -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:: diff --git a/docs/getting-started/generate-time-series/go.rst b/docs/getting-started/generate-time-series/go.rst index ef755cd2..290c7804 100644 --- a/docs/getting-started/generate-time-series/go.rst +++ b/docs/getting-started/generate-time-series/go.rst @@ -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 @@ -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:: diff --git a/docs/getting-started/generate-time-series/node.rst b/docs/getting-started/generate-time-series/node.rst index a456ad52..dab0eba7 100644 --- a/docs/getting-started/generate-time-series/node.rst +++ b/docs/getting-started/generate-time-series/node.rst @@ -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 @@ -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:: diff --git a/docs/getting-started/generate-time-series/python.rst b/docs/getting-started/generate-time-series/python.rst index a4ab5cc9..59da7803 100644 --- a/docs/getting-started/generate-time-series/python.rst +++ b/docs/getting-started/generate-time-series/python.rst @@ -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 @@ -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:: diff --git a/docs/getting-started/normalize-intervals.rst b/docs/getting-started/normalize-intervals.rst index 24412e50..773128c6 100644 --- a/docs/getting-started/normalize-intervals.rst +++ b/docs/getting-started/normalize-intervals.rst @@ -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 @@ -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. @@ -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: @@ -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 @@ -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. @@ -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. diff --git a/docs/index.rst b/docs/index.rst index 1a47007f..dbfb7cca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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. @@ -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 diff --git a/docs/integrations/azure-functions.rst b/docs/integrations/azure-functions.rst index 17a391a4..c26b787d 100644 --- a/docs/integrations/azure-functions.rst +++ b/docs/integrations/azure-functions.rst @@ -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 diff --git a/docs/integrations/kafka-connect.rst b/docs/integrations/kafka-connect.rst index 06bb9984..ab832a77 100644 --- a/docs/integrations/kafka-connect.rst +++ b/docs/integrations/kafka-connect.rst @@ -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 diff --git a/docs/integrations/ml-dist.rst b/docs/integrations/ml-dist.rst index 3e594fd4..4b013be1 100644 --- a/docs/integrations/ml-dist.rst +++ b/docs/integrations/ml-dist.rst @@ -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 diff --git a/docs/integrations/powerbi-desktop.rst b/docs/integrations/powerbi-desktop.rst index e4a094b8..f8cc67a5 100644 --- a/docs/integrations/powerbi-desktop.rst +++ b/docs/integrations/powerbi-desktop.rst @@ -100,13 +100,13 @@ Creating a DSN for CrateDB First, verify that you have installed the PostgreSQL ODBC driver by searching for and opening the ODBC Data Sources application for your architecture: -.. figure:: powerbi-start-menu.png +.. figure:: /_assets/img/integrations/powerbi-start-menu.png :align: center Navigate to the drivers tab, where you should see the PostgreSQL ODBC drivers you have installed: -.. figure:: powerbi-postgres-drivers.png +.. figure:: /_assets/img/integrations/powerbi-postgres-drivers.png :align: center If this is correct, you can add a User DSN by navigating to the User DSN tab @@ -119,7 +119,7 @@ are using a 64-bit Windows. Otherwise, select *PostgreSQL Unicode(x32)*. ` integration document, then you should create this DSN as a **System DSN**, not a **User DSN**. -.. figure:: powerbi-driver-select.png +.. figure:: /_assets/img/integrations/powerbi-driver-select.png :align: center Set up the data source with the following parameters: @@ -140,7 +140,7 @@ If your CrateDB instance uses SSL, enable the SSL mode. If the CrateDB user you're connecting with is password protected, add its password to the Password field. -.. figure:: powerbi-dsn-setup.png +.. figure:: /_assets/img/integrations/powerbi-dsn-setup.png :align: center You can click *Test* to verify that the DSN is configured correctly. Once this @@ -153,18 +153,18 @@ Connecting Power BI to CrateDB Once you have created the DSN, open up Power BI and click *Get Data* from the menu ribbon. Select *ODBC* from the list of available data sources: -.. figure:: powerbi-source.png +.. figure:: /_assets/img/integrations/powerbi-source.png :align: center Select CrateDB from the DSN list and click *OK*: -.. figure:: powerbi-crate-dsn.png +.. figure:: /_assets/img/integrations/powerbi-crate-dsn.png :align: center Within the ``doc`` schema, you should see and be able to add the ``population_data`` table: -.. figure:: powerbi-table-navigator.png +.. figure:: /_assets/img/integrations/powerbi-table-navigator.png :align: center From here you can transform the data as you wish, or click *Load* to load @@ -184,7 +184,7 @@ panel into the *Legend* section of the visualizations tab. The pie chart will be updated automatically, and will produce the following: -.. figure:: powerbi-pie-chart.png +.. figure:: /_assets/img/integrations/powerbi-pie-chart.png :align: center diff --git a/docs/integrations/powerbi-gateway.rst b/docs/integrations/powerbi-gateway.rst index 01bca980..30ab0f61 100644 --- a/docs/integrations/powerbi-gateway.rst +++ b/docs/integrations/powerbi-gateway.rst @@ -52,7 +52,7 @@ Follow Microsoft's documentation on how to `install`_ and `configure`_ the on-premises gateway. When it is finished installing and configuring, you should see something like the following status: -.. figure:: powerbi-gateway-status.png +.. figure:: /_assets/img/integrations/powerbi-gateway-status.png :align: center Ensure that the **Power BI** status for the gateway is **Ready**. @@ -68,7 +68,7 @@ guide to do this. After running through that guide, we should have the following report: -.. figure:: powerbi-pie-chart.png +.. figure:: /_assets/img/integrations/powerbi-pie-chart.png :align: center @@ -79,16 +79,16 @@ With your report created on Power BI desktop, you can now publish it to the online Power BI service. First, click the *Publish* button in the ribbon. Next, choose a destination to publish to: -.. figure:: powerbi-publish-destination.png +.. figure:: /_assets/img/integrations/powerbi-publish-destination.png :align: center When your publishing is successful, you can then open the report in the Power BI service: -.. figure:: powerbi-publish-success.png +.. figure:: /_assets/img/integrations/powerbi-publish-success.png :align: center -.. figure:: powerbi-published-report.png +.. figure:: /_assets/img/integrations/powerbi-published-report.png :align: center The report can now be shared via its URL. However, this is just a static @@ -107,13 +107,13 @@ Configuring The Gateway Within the Power BI service's settings, select *Manage Gateways*: -.. figure:: powerbi-manage-gateways.png +.. figure:: /_assets/img/integrations/powerbi-manage-gateways.png :align: center You should see the gateway cluster you set up. When you click *Test all connections*, you should see your cluster has the 'Online' status: -.. figure:: powerbi-gateway-clusters.png +.. figure:: /_assets/img/integrations/powerbi-gateway-clusters.png :align: center Click *Add data sources to use the gateway*. In the data source settings, @@ -130,7 +130,7 @@ the DSN when connecting Power BI Desktop to CrateDB. In this case, it was Hit apply, and if the settings are correct it will display that the connection was successful: -.. figure:: powerbi-connection-successful.png +.. figure:: /_assets/img/integrations/powerbi-connection-successful.png :align: center Once successful, go to the *Users* tab and select the users you would like to @@ -139,13 +139,13 @@ be able to access this data source to publish reports. Now, navigate back to the Power BI Service and click on the extra options for your ``population report`` data set, and click *Schedule refresh*. -.. figure:: powerbi-schedule-refresh.png +.. figure:: /_assets/img/integrations/powerbi-schedule-refresh.png :align: center In the *Gateway connection* section of the dataset's settings, configure the dataset to use the data gateway you set up previously and click apply: -.. figure:: powerbi-gateway-connection.png +.. figure:: /_assets/img/integrations/powerbi-gateway-connection.png :align: center The report is now configured to use the gateway. @@ -172,20 +172,20 @@ Now that the dataset powering our report has changed, you can refresh it. As before, click on the extra settings for the ``population report`` dataset, and click *Refresh now*. -.. figure:: powerbi-refresh-now.png +.. figure:: /_assets/img/integrations/powerbi-refresh-now.png :align: center If you navigate to the dataset settings, you should see that a refresh is in progress: -.. figure:: powerbi-refresh-in-progress.png +.. figure:: /_assets/img/integrations/powerbi-refresh-in-progress.png :align: center Once it succeeds, you should see a message in its place about when the successful refresh occurred. Once done, you can navigate back to your report and refresh it to see the new dataset underlying the pie chart: -.. figure:: powerbi-refreshed-report.png +.. figure:: /_assets/img/integrations/powerbi-refreshed-report.png :align: center As you can see, the report no longer contains 'Europe' as one of the regions. diff --git a/docs/integrations/r.rst b/docs/integrations/r.rst index f0de70ec..08927c29 100644 --- a/docs/integrations/r.rst +++ b/docs/integrations/r.rst @@ -179,7 +179,7 @@ of these properties across each species. > boxplot(petal_length~species, data=iris_dataset, main="Petal Length by Species") > boxplot(petal_width~species, data=iris_dataset, main="Petal Width by Species") -.. figure:: r-iris-features.png +.. figure:: /_assets/img/integrations/r-iris-features.png :align: center As we can see, the lengths and widths of sepals and petals are very good diff --git a/docs/integrations/streamsets.rst b/docs/integrations/streamsets.rst index f7e76200..2c38afc8 100644 --- a/docs/integrations/streamsets.rst +++ b/docs/integrations/streamsets.rst @@ -75,7 +75,7 @@ Using CrateDB as a Destination Firstly, create a new Data Collector Pipeline: -.. figure:: streamsets-new-pipeline.png +.. figure:: /_assets/img/integrations/streamsets-new-pipeline.png :align: center You can then add an origin for the pipeline. In this case, you will be reading @@ -83,7 +83,7 @@ from the .csv file you downloaded earlier. To do this, add a **Directory** origi for the pipeline. You should then configure the directory origin so that it picks up the New York taxi CSV file: -.. figure:: streamsets-directory-files.png +.. figure:: /_assets/img/integrations/streamsets-directory-files.png :align: center You can then also configure the data format of the file. The data format @@ -91,7 +91,7 @@ should be **delimited**, with the format type being **Default CSV**. The CSV file also includes a header line, so ensure the header line setting is **With Header Line**: -.. figure:: streamsets-directory-format.png +.. figure:: /_assets/img/integrations/streamsets-directory-format.png :align: center Before you can ingest this data into CrateDB, you need to perform some lightweight @@ -103,7 +103,7 @@ To do this, add a new **Field Type Converter** processor that connects to the Directory origin you created in the previous step. Once created, add the following field conversions to the field type converter's configuration: -.. figure:: streamsets-field-type-conversions.png +.. figure:: /_assets/img/integrations/streamsets-field-type-conversions.png :align: center Once configured, you can finally add CrateDB as a destination for the pipeline. @@ -113,27 +113,27 @@ connect to your CrateDB instance. The JDBC settings should be as follows: -.. figure:: streamsets-jdbc-producer-settings.png +.. figure:: /_assets/img/integrations/streamsets-jdbc-producer-settings.png :align: center -.. figure:: streamsets-jdbc-producer-credentials.png +.. figure:: /_assets/img/integrations/streamsets-jdbc-producer-credentials.png :align: center You can also look at the external libraries of the JDBC producer to ensure the CrateDB JDBC driver is present: -.. figure:: streamsets-jdbc-driver.png +.. figure:: /_assets/img/integrations/streamsets-jdbc-driver.png :align: center Once created, your pipeline should look something like this: -.. figure:: streamsets-pipeline.png +.. figure:: /_assets/img/integrations/streamsets-pipeline.png :align: center You can now start the pipeline by clicking the **Start** button, and data will flow from the CSV file, through the type transformer and into CrateDB: -.. figure:: streamsets-running-pipeline.png +.. figure:: /_assets/img/integrations/streamsets-running-pipeline.png :align: center You can verify that the data is now in CrateDB: diff --git a/docs/reference-architectures/cratedb-azure-iot.rst b/docs/reference-architectures/cratedb-azure-iot.rst index 8d542da3..a60e54cf 100644 --- a/docs/reference-architectures/cratedb-azure-iot.rst +++ b/docs/reference-architectures/cratedb-azure-iot.rst @@ -13,7 +13,7 @@ data-driven dashboards and reporting. .. _figure_1: -.. figure:: cratedb-azure-iot.png +.. figure:: /_assets/img/reference-architectures/cratedb-azure-iot.png :align: center diff --git a/docs/reference-architectures/distributed-ml.rst b/docs/reference-architectures/distributed-ml.rst index 44c99f17..9feef9c1 100644 --- a/docs/reference-architectures/distributed-ml.rst +++ b/docs/reference-architectures/distributed-ml.rst @@ -23,7 +23,7 @@ Prometheus node running in the cloud layer. .. _figure_1: -.. figure:: distributed-ml.png +.. figure:: /_assets/img/reference-architectures/distributed-ml.png :align: center diff --git a/docs/requirements.txt b/docs/requirements.txt index ced14fe9..8a83a83d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -crate-docs-theme +crate-docs-theme==0.30.0.dev3