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.

Sign up for GitHub

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

fix(docs): indentation formatting on several admonitions #701

Merged
merged 2 commits into from
Apr 4, 2024
Merged

fix(docs): indentation formatting on several admonitions #701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a5264f
fix(docs): indentation formatting on several admonitions
vidofnir Apr 3, 2024
8959d1b
Merge branch 'main' into main
vidofnir Apr 4, 2024
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
4 changes: 2 additions & 2 deletions docs/docs/installation/helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ helm install aiven-operator aiven/aiven-operator
```

!!! note
Installation will fail if webhooks are enabled and the CRDs for the cert-manager are not installed.
Installation will fail if webhooks are enabled and the CRDs for the cert-manager are not installed.

Verify the installation:

Expand Down Expand Up @@ -80,7 +80,7 @@ If the person installing the Helm chart does not have the necessary permissions
## Uninstalling

!!! important
Please see [this page](uninstalling.md) for more information.
Please see [this page](uninstalling.md) for more information.

Find out the name of your deployment:

Expand Down
12 changes: 7 additions & 5 deletions docs/docs/installation/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ The Aiven Operator for Kubernetes uses `cert-manager` to configure the [service
Please follow the [installation instructions](https://cert-manager.io/docs/installation/helm/) on their website.

!!! note
This is not required in the Helm installation if you select to [disable webhooks](./helm.md),
but that is not recommended outside of playground use.
The Aiven Operator for Kubernetes uses webhooks for setting defaults
and enforcing invariants that are expected by the aiven API and will lead to errors if ignored.
In the future webhooks will also be used for conversion and supporting multiple CRD versions.
This is not required in the Helm installation if you select to [disable webhooks](./helm.md),
but that is not recommended outside of playground use.

The Aiven Operator for Kubernetes uses webhooks for setting defaults
and enforcing invariants that are expected by the aiven API and will lead to errors if ignored.

In the future webhooks will also be used for conversion and supporting multiple CRD versions.
2 changes: 1 addition & 1 deletion docs/docs/resources/cassandra.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 55
Aiven for Apache Cassandra® is a distributed database designed to handle large volumes of writes.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)) and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)), and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

## Creating a Cassandra instance

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/resources/kafka/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Aiven for Apache Kafka is an excellent option if you need to run Apache Kafka at
you can get up and running with a suitably sized Apache Kafka service in a few minutes.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../../installation/prerequisites.md) with the
operator installed (see instructions for [helm](../../installation/helm.md) or [kubectl](../../installation/kubectl.md))
and a [Kubernetes Secret with an Aiven authentication token](../../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../../installation/prerequisites.md) with the
operator installed (see instructions for [helm](../../installation/helm.md) or [kubectl](../../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../../authentication.md).

## Creating a Kafka instance

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/resources/opensearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ weight: 45
OpenSearch® is an open source search and analytics suite including search engine, NoSQL document database, and visualization interface. OpenSearch offers a distributed, full-text search engine based on Apache Lucene® with a RESTful API interface and support for JSON documents.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md))
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

## Creating an OpenSearch instance

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/resources/postgresql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ extender for location queries. Aiven for PostgreSQL is the perfect fit for your
With Aiven Kubernetes Operator, you can manage Aiven for PostgreSQL through the well defined Kubernetes API.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

## Creating a PostgreSQL instance

Expand Down Expand Up @@ -361,7 +361,7 @@ spec:
```

!!! note
You can create the replica service in a different region or on a different cloud provider.
You can create the replica service in a different region or on a different cloud provider.

2\. Apply the configuration with the following command:

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/resources/project-vpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ directly without going through the public internet.
Within the Aiven Kubernetes Operator, you can create a `ProjectVPC` on Aiven's side to connect to your cloud provider.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

## Creating an Aiven VPC

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/resources/project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ weight: 5
---

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md))
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

The `Project` CRD allows you to create Aiven Projects, where your resources can be located.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/resources/redis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ weight: 50
Aiven for Redis®\* is a fully managed in-memory NoSQL database that you can deploy in the cloud of your choice to store and access data quickly and efficiently.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md))
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

## Creating a Redis instance

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/resources/service-integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ our [Getting Started with Service Integrations guide](https://aiven.io/docs/plat
for more information.

!!! note
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).
Before going through this guide, make sure you have a [Kubernetes cluster](../installation/prerequisites.md) with the operator installed (see instructions for [helm](../installation/helm.md) or [kubectl](../installation/kubectl.md)),
and a [Kubernetes Secret with an Aiven authentication token](../authentication.md).

## Send Kafka logs to a Kafka Topic

Expand Down
Loading