Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

Commit

Permalink
Adjust to upstream changes
Browse files Browse the repository at this point in the history
This will use a) the dependencies and b) the intersphinx links from
upstream "create-docs-theme".
  • Loading branch information
amotl committed Jun 9, 2021
1 parent 797a10e commit 09e4dd2
Show file tree
Hide file tree
Showing 12 changed files with 68 additions and 76 deletions.
6 changes: 0 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@


intersphinx_mapping.update({
'reference': ('https://crate.io/docs/crate/reference/', None),
'crate-python': ('https://crate.io/docs/python/', None),
'howtos': ('https://crate.io/docs/crate/howtos/', None),
'admin-ui': ('https://crate.io/docs/crate/admin-ui/', None),
'crash': ('https://crate.io/docs/crate/crash/', None),
'clients-tools': ('https://crate.io/docs/crate/clients-tools/', None),
'matplotlib': ('https://matplotlib.org/stable/', None),
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
'numpy': ('https://numpy.org/doc/stable/', None),
Expand Down
6 changes: 3 additions & 3 deletions docs/create-sharded-table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Create sharded table
====================

One core concept CrateDB uses to distribute data across a cluster is
:ref:`sharding <reference:ddl-sharding>`. CrateDB splits every table into a
:ref:`sharding <crate-reference:ddl-sharding>`. CrateDB splits every table into a
configured number of shards, which are distributed evenly across the cluster.
You can think of shards as a self-contained part of a table, that includes both
a subset of records and corresponding indexing structures. If we
:ref:`create a table <reference:sql_ddl_create>` like the following:
:ref:`create a table <crate-reference:sql_ddl_create>` like the following:

.. code-block:: psql
Expand Down Expand Up @@ -44,7 +44,7 @@ Partitioning
============

CrateDB also supports splitting up data across another dimension with
:ref:`partitioning <reference:partitioned-tables>`. You can think of a
:ref:`partitioning <crate-reference:partitioned-tables>`. You can think of a
partition as a set of shards. For each partition the number of shards defined
by ``CLUSTERED INTO x SHARDS`` are created, when a first row with a specific
``partition key`` is inserted.
Expand Down
12 changes: 6 additions & 6 deletions docs/create-user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Introduction
------------

This part of the documentation sheds some light on the topics of
:ref:`reference:administration_user_management` and
:ref:`reference:administration-privileges`.
:ref:`crate-reference:administration_user_management` and
:ref:`crate-reference:administration-privileges`.

CrateDB ships with a superuser account called "``crate``", which has the
privileges to perform any action. However, with the default configuration, this
Expand All @@ -20,13 +20,13 @@ installed on. If you are trying to connect from another machine, you are
prompted to enter a username and password.

In order to create a user that can be used to authenticate from a remote
machine, first :ref:`install crash <crash:getting-started>` or other
machine, first :ref:`install crash <crate-crash:getting-started>` or other
:ref:clients-tools:index` on the same machine you installed CrateDB on.
Then, connect to CrateDB running on ``localhost``.

While you can also perform the steps outlined below within
:ref:`admin-ui:index` itself, the walkthrough will outline how to do it
using the :ref:`crash:index` on the command line.
:ref:`crate-admin-ui:index` itself, the walkthrough will outline how to do it
using the :ref:`crate-crash:index` on the command line.


-------
Expand All @@ -53,7 +53,7 @@ Grant all privileges to the newly created user:
.. image:: _assets/img/create-user.png

Now try navigating to the :ref:`admin-ui:index` in your browser. In the URL
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
of the machine CreateDB is running on and sign in with your newly created user
account::
Expand Down
10 changes: 5 additions & 5 deletions docs/first-use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Introducing the Admin UI
========================

CrateDB ships with a browser-based administration interface called
:ref:`Admin UI <admin-ui:index>`.
:ref:`Admin UI <crate-admin-ui:index>`.

The CrateDB Admin UI runs on every CrateDB node, and you can use it to inspect
and interact with the whole CrateDB cluster in a number of ways.
Expand All @@ -46,7 +46,7 @@ Introducing the CrateDB Shell
The CrateDB Shell (aka Crash) is an interactive command-line interface (CLI)
program for working with CrateDB on your favorite terminal. For further
information about it, please follow up on its documentation at
:ref:`crash:index`.
:ref:`crate-crash:index`.

.. NOTE::

Expand Down Expand Up @@ -75,7 +75,7 @@ Start building with CrateDB clients and tools
=============================================

If you'd like to skip the tutorials and start building with CrateDB, you can
find a list of :ref:clients-tools:index` in a different section of the
find a list of :ref:`crate-clients-tools:index` in a different section of the
documentation.


Expand All @@ -84,5 +84,5 @@ documentation.
Dive into CrateDB
=================

Check out the :ref:`howtos:index` for goal oriented topics. Alternatively,
check out the :ref:`reference:index` for a complete reference manual.
Check out the :ref:`crate-howtos:index` for goal oriented topics. Alternatively,
check out the :ref:`crate-reference:index` for a complete reference manual.
12 changes: 6 additions & 6 deletions docs/generate-time-series/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Generate time series data from the command line

This tutorial will show you how to generate :ref:`mock time series data
<gen-ts>` about the `International Space Station`_ (ISS) using the
:ref:`crash:index` and a little bit of `shell scripting`_.
:ref:`crate-crash:index` and a little bit of `shell scripting`_.

.. SEEALSO::

Expand All @@ -23,7 +23,7 @@ Prerequisites

CrateDB must be :ref:`installed and running <install>`.

Crash is available as `pip`_ package. :ref:`Install <crash:getting-started>` it
Crash is available as `pip`_ package. :ref:`Install <crate-crash:getting-started>` it
like this:

.. code-block:: console
Expand Down Expand Up @@ -153,7 +153,7 @@ Start an interactive Crash session:
Modify the argument if you wish to connect to a CrateDB node on a different
host or port number.

Then, :ref:`create a table <reference:sql_ddl_create>` suitable for writing
Then, :ref:`create a table <crate-reference:sql_ddl_create>` suitable for writing
load averages.

.. code-block:: psql
Expand All @@ -165,7 +165,7 @@ load averages.
CREATE OK, 1 row affected (0.726 sec)
In the :ref:`admin-ui:index`, you should see the new table when you navigate
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
Expand All @@ -181,7 +181,7 @@ statements directly from the command line.

First, exit from the interactive Crash session (or open a new terminal). Then,
use ``crash`` with the ``--command`` argument to execute an :ref:`INSERT
<reference:inserting_data>` query.
<crate-reference:inserting_data>` query.

.. code-block:: console
Expand All @@ -199,7 +199,7 @@ use ``crash`` with the ``--command`` argument to execute an :ref:`INSERT
Press the up arrow on your keyboard and hit *Enter* to run the same command a
few more times.

When you're done, you can :ref:`select <reference:sql_dql_queries>` that data
When you're done, you can :ref:`select <crate-reference:sql_dql_queries>` that data
back out of CrateDB.

.. code-block:: console
Expand Down
14 changes: 7 additions & 7 deletions docs/generate-time-series/go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ keys which don't have a corresponding struct field are ignored.
Now, create a function that makes an HTTP GET request to the Open Notify API
endpoint and returns longitude and latitude as a
:ref:`reference:geo_point_data_type` declaration.
:ref:`crate-reference:geo_point_data_type` declaration.

.. code-block:: go
Expand Down Expand Up @@ -231,8 +231,8 @@ client:
)
Then, in your main function, connect to CrateDB using the
:ref:`reference:postgres_wire_protocol` port (``5432``) and
:ref:`create a table <reference:sql_ddl_create>` suitable for writing ISS
:ref:`crate-reference:postgres_wire_protocol` port (``5432``) and
:ref:`create a table <crate-reference:sql_ddl_create>` suitable for writing ISS
position coordinates.

.. code-block:: go
Expand Down Expand Up @@ -265,7 +265,7 @@ Save your changes and run the code:
When you run the script this time, the ``go`` command will look up the module
containing the `pgx`_ package and add it to ``go.mod``.

In the :ref:`admin-ui:index`, you should see the new table when you navigate
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
Expand All @@ -277,7 +277,7 @@ Record the ISS position
With the table in place, you can start recording the position of the ISS.

Create some logic that calls your ``getISSPosition`` function and :ref:`insert
<reference:inserting_data>` the result into the ``iss`` table.
<crate-reference:inserting_data>` the result into the ``iss`` table.

.. code-block:: go
Expand Down Expand Up @@ -309,7 +309,7 @@ Save your changes and run the code:
Press the up arrow on your keyboard and hit *Enter* to run the same command a
few more times.

When you're done, you can :ref:`select <reference:sql_dql_queries>` that data
When you're done, you can :ref:`select <crate-reference:sql_dql_queries>` that data
back out of CrateDB with this query:

.. code-block:: psql
Expand Down Expand Up @@ -399,7 +399,7 @@ Run the script from the command line:
Sleeping for 10 seconds...
As the script runs, you should see the table filling up in the
:ref:`admin-ui:index`.
:ref:`crate-admin-ui:index`.

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

Expand Down
10 changes: 5 additions & 5 deletions docs/generate-time-series/node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ First, import the `node-postgres`_ client:
> const { Client } = require('pg')
Then `connect`_ to CrateDB, using the :ref:`reference:postgres_wire_protocol` port
Then `connect`_ to CrateDB, using the :ref:`crate-reference:postgres_wire_protocol` port
(``5432``):

.. code-block:: js
Expand All @@ -129,7 +129,7 @@ Then `connect`_ to CrateDB, using the :ref:`reference:postgres_wire_protocol` po
> await client.connect()
Finally, :ref:`create a table <reference:sql_ddl_create>` suitable for writing
Finally, :ref:`create a table <crate-reference:sql_ddl_create>` suitable for writing
ISS position coordinates.

.. code-block:: js
Expand Down Expand Up @@ -168,7 +168,7 @@ ISS position coordinates.
Success!

In the :ref:`admin-ui:index`, you should see the new table when you navigate to
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
Expand All @@ -180,7 +180,7 @@ Record the ISS position
With the table in place, you can start recording the position of the ISS.

The following command calls your ``position`` function and will :ref:`insert
<reference:inserting_data>` the result into the ``iss`` table.
<crate-reference:inserting_data>` the result into the ``iss`` table.

.. code-block:: js
Expand Down Expand Up @@ -212,7 +212,7 @@ The following command calls your ``position`` function and will :ref:`insert
Press the up arrow on your keyboard and hit *Enter* to run the same command a
few more times.

When you're done, you can :ref:`select <reference:sql_dql_queries>` that data
When you're done, you can :ref:`select <crate-reference:sql_dql_queries>` that data
back out of CrateDB.

.. code-block:: js
Expand Down
8 changes: 4 additions & 4 deletions docs/generate-time-series/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Get a :ref:`cursor <crate-python:cursor>`:

>>> cursor = connection.cursor()

Finally, :ref:`create a table <reference:sql_ddl_create>` suitable for writing
Finally, :ref:`create a table <crate-reference:sql_ddl_create>` suitable for writing
ISS position coordinates.

>>> cursor.execute(
Expand All @@ -119,7 +119,7 @@ ISS position coordinates.
... position GEO_POINT)"""
... )

In the :ref:`admin-ui:index`, you should see the new table when you navigate to
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
Expand All @@ -131,14 +131,14 @@ Record the ISS position
With the table in place, you can start recording the position of the ISS.

The following command calls your ``position`` function and will :ref:`insert
<reference:inserting_data>` the result into the ``iss`` table:
<crate-reference:inserting_data>` the result into the ``iss`` table:

>>> cursor.execute("INSERT INTO iss (position) VALUES (?)", [position()])

Press the up arrow on your keyboard and hit *Enter* to run the same command a
few more times.

When you're done, you can :ref:`select <reference:sql_dql_queries>` that data
When you're done, you can :ref:`select <crate-reference:sql_dql_queries>` that data
back out of CrateDB.

>>> cursor.execute('SELECT * FROM iss ORDER BY timestamp DESC')
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ massive amounts of machine data in real-time.

.. SEEALSO::

Check out the :ref:`howtos:index` and the :ref:`reference:index`.
Check out the :ref:`crate-howtos:index` and the :ref:`crate-reference:index`.

.. NOTE::

Expand Down
20 changes: 10 additions & 10 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ release channels, you can also download release archives and run CrateDB
manually using the :ref:`install-adhoc` method.

When the installation is finished, the CrateDB service should be up and
running. Then, you can access the :ref:`Admin UI <admin-ui:index>` from your
running. Then, you can access the :ref:`Admin UI <crate-admin-ui:index>` from your
local machine by navigating to::

http://localhost:4200/
Expand Down Expand Up @@ -218,8 +218,8 @@ official `CrateDB Docker image`_, use::
.. TIP::

If this command aborts with an error, please consult the :ref:`Docker
troubleshooting guide <howtos:docker-troubleshooting>`. You are also
welcome learn more about :ref:`howtos:resource_constraints` with respect
troubleshooting guide <crate-howtos:docker-troubleshooting>`. You are also
welcome learn more about :ref:`crate-howtos:resource_constraints` with respect
to running CrateDB within containers.

.. CAUTION::
Expand All @@ -231,7 +231,7 @@ official `CrateDB Docker image`_, use::
container, all data will be lost.

When you are ready to start using CrateDB for data you care about, please
consult the :ref:`full guide to CrateDB and Docker <howtos:cratedb-docker>`
consult the :ref:`full guide to CrateDB and Docker <crate-howtos:cratedb-docker>`
in order to configure the Docker setup appropriately by using persistent
disk volumes.

Expand Down Expand Up @@ -275,7 +275,7 @@ install CrateDB. The walkthrough is suitable to install and run CrateDB on both

.. SEEALSO::

Consult the :ref:`reference:cli` documentation for further information
Consult the :ref:`crate-reference:cli` documentation for further information
about the ``./bin/crate`` command.


Expand Down Expand Up @@ -316,7 +316,7 @@ Environment variables
---------------------

When using the package-based setup flavor for :ref:`install-deb` or
:ref:`install-rpm`, the CrateDB startup script uses :ref:`reference:conf-env`
:ref:`install-rpm`, the CrateDB startup script uses :ref:`crate-reference:conf-env`
from the ``/etc/default/crate`` file. When using the :ref:`install-adhoc`
setup, the environment variables will be set by ``bin/crate{.sh,.bat}``.

Expand Down Expand Up @@ -350,11 +350,11 @@ After successfully installing the software, you might want to follow up with

Also, you might enjoy to be guided into further information about how to
quickly adjust the :ref:`configuration settings <install-configure>`, read more
details about the :ref:`reference:config` of CrateDB, the background about
:ref:`howtos:bootstrap-checks`, multi-node configuration within the section
about :ref:`howtos:clustering` and :ref:`howtos:going-into-production`. When
details about the :ref:`crate-reference:config` of CrateDB, the background about
:ref:`crate-howtos:bootstrap-checks`, multi-node configuration within the section
about :ref:`crate-howtos:clustering` and :ref:`crate-howtos:going-into-production`. When
operating a CrateDB cluster in production, :ref:`performance tuning
<howtos:performance>` will also be of interest.
<crate-howtos:performance>` will also be of interest.

.. NOTE::

Expand Down
Loading

0 comments on commit 09e4dd2

Please sign in to comment.