Skip to content

Commit

Permalink
Fix the backticks in blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
matkuliak committed Mar 5, 2024
1 parent 1c3cc71 commit 6b779a0
Show file tree
Hide file tree
Showing 26 changed files with 383 additions and 338 deletions.
4 changes: 2 additions & 2 deletions docs/howtos/add-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ New users can be added to an organization by going to the Users tab in the
left-hand menu. To add and manage users of the organization, you must be the
organization admin.

````{note}
:::{note}
For more information on user roles and associated privileges, see the
documentation on {ref}`user roles <user-roles>`.
````
:::

![Cloud Console users overview](../_assets/img/users-overview.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/howtos/delete-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ specifically within the Console, this tutorial provides a step-by-step
guide for *all* methods of deleting a CrateDB Cloud cluster. This is to
make the process more transparent and easier to find and use.

````{Warning}
:::{Warning}
All cluster data will be lost on deletion. This action cannot be undone.
````
:::

(delete-cluster-azure)=
## Microsoft Azure
Expand Down
12 changes: 6 additions & 6 deletions docs/howtos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Cloud Console. Alternatively, you can use the command-line interface CrateDB
Cloud CLI, aka. {ref}`Croud <cloud-cli:index>`.


````{note}
:::{note}
Not all operations supported by the CrateDB Cloud Console are also
available via Croud. Most importantly, clusters can only be deployed via
the CrateDB Cloud Console.
````
:::

```{toctree}
:::{toctree}
:hidden:
:maxdepth: 1

Expand All @@ -28,7 +28,7 @@ Delete Cluster <delete-cluster>
Restore Backups <restore-backups>
Logical Replication <logical-replication>
Private Endpoints <private-endpoints>
```
:::

:::
## Organization Management
Expand Down Expand Up @@ -108,7 +108,7 @@ your favorite client library to connect to a CrateDB cluster.

::::

````{note}
:::{note}
This is an open source documentation project. We host the source code and
issue tracker on [GitHub](https://github.com/crate/cloud-docs/) .
````
:::
20 changes: 10 additions & 10 deletions docs/howtos/logical-replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,28 @@ subscription is created on a cluster where the data should be copied to.

Example publication:

``` sql
:::{code} sql
CREATE PUBLICATION mypublication
FOR ALL TABLES
```
:::

(logical-replication-create-subscription)=
### Create a subscription on Cluster 2

Example subscription:

``` sql
:::{code} sql
CREATE SUBSCRIPTION mysubscription
CONNECTION 'crate://your-cluster-url.cratedb.net?mode=pg_tunnel&user=your_user&password=your_password'
PUBLICATION mypublication;
```
:::

````{note}
:::{note}
By default, CrateDB uses the transport protocol (on port 4300) for
logical replication. If the port is not available (such as with CrateDB
Cloud), the `mode=pg_tunnel` can be used to tunnel over the Postgres
protocol (port 5432).
`````
:::

That's it in terms of configuration. Data from Cluster 1 will now be
automatically replicated on Cluster 2. This feature can also be
Expand All @@ -66,18 +66,18 @@ the cluster that serves as the target.

Example publication:

``` sql
:::{code} sql
DROP PUBLICATION mypublication
```
:::

(logical-replication-remove-subscription)=
### Remove a subscription from Cluster 2

Example subscription:

``` sql
:::{code} sql
DROP SUBSCRIPTION mysubscription
```
:::

(logical-replication-conclusion)=
## Conclusion
Expand Down
4 changes: 2 additions & 2 deletions docs/howtos/private-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ bottom. In order to request a private link, select *Request Private
Link*. Fill out the requested information and select *OK*. We will get
back to you as soon as possible.

````{note}
:::{note}
Private endpoints do not work across providers, meaning that if you want
to securely access your AWS cluster, you must do so from within the AWS
environment.
````
:::
8 changes: 4 additions & 4 deletions docs/howtos/reconfigure-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ change plans and scale the number of nodes at the same time.
The difference in the price of the cluster can be seen on the bottom
right, when choosing different configurations.

````{note}
:::{note}
Any promotions or discounts applicable to your cluster will be applied
to your organization as a whole at the end of the billing period. Due to
technical limitations, they may not be directly visible in the cluster
scale pricing shown here, but do not worry! This does not mean that your
promotion or discount is not functioning.
````
:::

````{warning}
:::{warning}
Storage capacity increases for a given cluster are irreversible. To
reduce cluster storage capacity, reduce the cluster nodes instead (up to
a minimum of 2, although we recommend maintaining a minimum of 3 for
production use).
````
:::
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,13 @@ Learn how to import data into your CrateDB Cloud clusters.
::::


```{note}
:::{note}
Like [CrateDB itself], this is an open source documentation project. [Suggestions
for improvements], and [source code contributions], are always welcome. {fab}`github`
```
:::


```{toctree}
:::{toctree}
:maxdepth: 1
:hidden:

Expand All @@ -127,7 +127,7 @@ Web Console <reference/overview>
Croud CLI <tutorials/deploy/croud>
tutorials/edge/index
Reference <reference/index>
```
:::

[CrateDB]: https://crate.io/product/
[Croud CLI]: https://crate.io/docs/cloud/cli/
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ as you cannot access it again.
The key and secret can be used as HTTP Basic Auth credentials when
calling the API, e.g.

``` console
:::{code} console
sh$ $ curl -s -u $your_key:$your_secret https://console.cratedb.cloud/api/v2/users/me
```
:::

This example will return details of the current user:

``` console
:::{code} console
{"email":"some@example.com","hmac":"...","is_superuser":false,"name":"Some User","organization_id":"123","status":"active","uid":"uid","username":"some@example.com"}
```
:::

(api-examples)=
## Examples
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,14 @@ created directly with Crate.

![Custom contract payment option](../_assets/img/custom-contract.png)

````{note}
:::{note}
This type of payment method does not show up in your Cloud console
automatically as it needs to be configured specifically for every
customer.

If you're interested in this option, don't hesitate and contact us at
**sales@crate.io**
````
:::

## Payment processing {#billing-processing}

Expand All @@ -103,4 +103,4 @@ by [Stripe](https://stripe.com/). For clusters deployed through the
Marketplace](https://portal.azure.com/#create/crate.cratedbcloud/preview)
and the [AWS
Marketplace](https://aws.amazon.com/marketplace/pp/B089M4B1ND), payment
is handled by Stripe on behalf of the respective marketplaces.
is handled by Stripe on behalf of the respective marketplaces.
37 changes: 19 additions & 18 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ concepts in the CrateDB Cloud Console and its documentation, the Croud
CLI, and other resources related to CrateDB Cloud. The items are
presented in alphabetical order.

````{note}
:::{note}
While learning about CrateDB Cloud, please also visit the {ref}`CrateDB
glossary <crate-reference:appendix-glossary>`It enumerates
all terms related to the CrateDB database in general.
````
:::

**Table of contents**

- [Audit log](#gloss-audit-log)
Expand Down Expand Up @@ -119,9 +120,9 @@ web interface such as the CrateDB Cloud
is the default way to interact with CrateDB Cloud, and currently
clusters can only be deployed within the Console.

````{note}
:::{note}
See also: Croud CLI {ref}`documentation <cluster-deployment-croud>`.
````
:::

(gloss-cloud-on-kubernetes)=
## CrateDB Cloud on Kubernetes
Expand Down Expand Up @@ -165,10 +166,10 @@ members. Such organization admins and members have access to the
clusters run by the organization. One account can be a member or admin
of multiple organizations.

````{note}
:::{note}
For more on user roles in CrateDB Cloud and how to manage them, see the
{ref}`reference for user roles <user-roles>`.
````
:::

Each organization has a name, a unique ID, and optionally an associated
email address. For information on how to create an organization, please
Expand Down Expand Up @@ -221,10 +222,10 @@ of different scale units. Each scale unit represents an (additional)
unit multiplying the specific combination of hardware capacity
that applies to that plan.

````{note}
:::{note}
See also [Scale your
cluster guide](https://crate.io/docs/cloud/howtos/en/latest/reconfigure-cluster.html)
````
:::

(gloss-subscription)=
## Subscription
Expand All @@ -243,7 +244,7 @@ multiple subscriptions. This can be practical in case that customer
wants to separate different instances of using the CrateDB Cloud service
into different billing accounts.

````{note}
:::{note}
[Subscribe to CrateDB
Cloud](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/stripe.html)

Expand All @@ -254,7 +255,7 @@ Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/
Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-azure/subscribe-azure.html)

{ref}`Services <services>`
````
:::

(gloss-subscription-plan)=
## Subscription plan
Expand All @@ -270,7 +271,7 @@ deployment <deploy-cluster>`, and also multiple plans and a separate contract op
through the Marketplace {ref}`offers <gloss-offer>`. For more information,
refer to the documentation on {ref}` services we offer <services>`.

````{note}
:::{note}
See also:

[Subscribe to CrateDB
Expand All @@ -283,7 +284,7 @@ Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/
Marketplace](https://crate.io/docs/cloud/tutorials/en/latest/cluster-deployment/deploy-to-cluster-marketplace/deploy-to-cluster-azure/subscribe-azure.html)

{ref}`Deployment <cluster-deployment>`
````
:::

(gloss-system-user)=
## System user
Expand All @@ -300,9 +301,9 @@ In CrateDB Cloud, there are two distinct system
{ref}`explanation <system-user>` in the
CrateDB Cloud reference.

````{note}
:::{note}
See also {ref}`Audit Log <overview-org-audit>`
````
:::

(gloss-tier)=
## Tier
Expand All @@ -324,9 +325,9 @@ a defined role within the organization (see documentation on {ref}`user roles
<user-roles>`) and is associated with a
specific email address.

````{note}
:::{note}
See also: {ref}`User roles <user-roles>`
````
:::

(gloss-version)=
## Versions
Expand Down Expand Up @@ -355,6 +356,6 @@ sequence, e.g. the 4 in 'version 5.3.4'. All available upgrades are
visible in the {ref}`Manage Tab <overview-cluster-manage>` of the
cluster detailed view.

````{note}
:::{note}
See also: {ref}`CrateDB Release Notes <crate-reference:release_notes>`
````
:::
8 changes: 4 additions & 4 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ clusters in the cloud – without needing to worry about database management.
CrateDB is a distributed, open-source database that combines the performance of
NoSQL with the power and simplicity of standard SQL.

```{toctree}
:::{toctree}
:hidden:
:maxdepth: 1

User Roles <user-roles>
Billing <billing>
API <api>
Glossary <glossary>
```
:::

````{note}
:::{note}
This is an open source documentation project. We host the source code and
issue tracker on [GitHub](https://github.com/crate/cloud-docs/).
`````
:::
Loading

0 comments on commit 6b779a0

Please sign in to comment.