Skip to content

Commit

Permalink
fix: metadescriptions (#584)
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurFlag authored Dec 2, 2024
1 parent e635aaf commit c5ee83d
Show file tree
Hide file tree
Showing 27 changed files with 84 additions and 102 deletions.
22 changes: 12 additions & 10 deletions docs/platform/howto/manage-organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@
title: Manage organizations
---

Learn how to manage your organizations via the Aiven Console.

## Delete an organization

1. Delete all
[projects](/docs/platform/howto/manage-project) in the organization and in the organizational units.
2. Click **Admin**.
3. Click **Organization**.
4. Open each organizational unit by clicking its name then click
1. Click **Admin**.
1. Click **Organization**.
1. Open each organizational unit by clicking its name then click
**Delete** to delete it.
5. After all the organizational units have been deleted, on the
1. After all the organizational units have been deleted, on the
**Organization** page click **Delete**.
6. Confirm to delete the organization by clicking
1. Confirm to delete the organization by clicking
**Delete**.

## Rename an organization

1. In the organization, click **Admin**.
2. Click **Organization**.
3. Click **Rename**.
4. Select **Rename**.
5. Enter the new name.
6. Click **Rename**.
1. Click **Organization**.
1. Click **Rename**.
1. Select **Rename**.
1. Enter the new name.
1. Click **Rename**.
8 changes: 5 additions & 3 deletions docs/platform/howto/manage-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ title: Manage projects
import ConsoleLabel from "@site/src/components/ConsoleIcons"
import {ConsoleIcon} from "@site/src/components/ConsoleIcons"

Learn how to manage your projects with the Aiven Console.

## Create a project

1. Click <ConsoleLabel name="Projects"/> and select **Create project**.
2. Enter a name for the project.
3. Select an organization or organizational unit to add the project to.
4. Select a [billing group](/docs/platform/concepts/billing-groups-overview).
1. Enter a name for the project.
1. Select an organization or organizational unit to add the project to.
1. Select a [billing group](/docs/platform/concepts/billing-groups-overview).
The costs from all services in this project are charged to the
payment method for this billing group.

Expand Down
9 changes: 6 additions & 3 deletions docs/platform/reference/service-ip-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
title: Default service IP address and hostname
---

When a new Aiven service is created, it automatically gets a hostname and one or more public IP addresses.

## Default service IP address

When a new Aiven service is created, the chosen cloud service provider
will dynamically assign one or more public IP address from their
connection pool. This IP address is not permanent, and with every
The chosen cloud service provider will dynamically assign one or more public IP
address from their connection pool.

This IP address is not permanent, and with every
service maintenance (in case of failover, maintenance upgrade or cloud
migration) the IP address changes since Aiven creates a new node,
migrates the existing data to it and retire the old node.
Expand Down
1 change: 0 additions & 1 deletion docs/products/caching/howto/connect-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import MyComponentSource1 from '!!raw-loader!/code/products/redis/connect.js';

Learn how to connect to an Aiven for Caching service using NodeJS with the `ioredis` library.


## Variables

Replace the following placeholders in the code sample with actual values
Expand Down
3 changes: 1 addition & 2 deletions docs/products/clickhouse/howto/connect-with-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: Connect to the Aiven for ClickHouse® service with PHP
---

Learn how to connect to your Aiven for ClickHouse® service with PHP
using the PHP ClickHouse client and the HTTPS port.
Learn how to connect to your Aiven for ClickHouse® service with PHP using the PHP ClickHouse client and the HTTPS port.

## Prerequisites

Expand Down
2 changes: 2 additions & 0 deletions docs/products/clickhouse/howto/list-connect-to-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ title: Connect to your Aiven for ClickHouse® service

import DocCardList from '@theme/DocCardList';

Discover the various ways to connect to your Aiven for ClickHouse® service.

<DocCardList />
4 changes: 1 addition & 3 deletions docs/products/kafka/concepts/kafka-rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: Apache Kafka® REST API
---

[Karapace](https://github.com/aiven/karapace) provides a RESTful
interface to your Apache Kafka® cluster, allowing you to produce and
consume messages and perform administrative cluster work.
[Karapace](https://github.com/aiven/karapace) provides a RESTful interface to your Apache Kafka® cluster, allowing you to produce and consume messages and perform administrative cluster work.

Authorization can be enabled for Apache Kafka® REST APIs using Apache
Kafka® REST proxy authorization. The authorization rules are based on
Expand Down
16 changes: 7 additions & 9 deletions docs/products/kafka/howto/fake-sample-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: Sample dataset generator for Aiven for Apache Kafka®
sidebar_label: Sample data
---

Learning to work with streaming data is much more fun with data, so to
get you started on your Apache Kafka® journey we help you create fake
streaming data to a topic.
Learn to work with streaming data with sample data to get you started on your Apache Kafka® journey.

:::note
The following example is based on [Docker](https://www.docker.com/)
Expand All @@ -30,9 +28,9 @@ To start using the generator:
git clone https://github.com/aiven/fake-data-producer-for-apache-kafka-docker
```
2. Copy the file `conf/env.conf.sample` to `conf/env.conf`
1. Copy the file `conf/env.conf.sample` to `conf/env.conf`
3. Create a [token](/docs/platform/howto/create_authentication_token) in the Aiven
1. Create a [token](/docs/platform/howto/create_authentication_token) in the Aiven
Console or using the following command in the
[Aiven CLI](/docs/tools/cli),
changing the `max-age-seconds` appropriately for the duration of
Expand All @@ -53,7 +51,7 @@ To start using the generator:
the token.
:::
4. Edit the `conf/env.conf` file filling the following placeholders:
1. Edit the `conf/env.conf` file filling the following placeholders:
- `my_project_name`: the name of your Aiven project
- `my_kafka_service_name`: the name of your Aiven for Apache Kafka
Expand All @@ -64,7 +62,7 @@ To start using the generator:
- `my_aiven_token`: the personal token generated during the previous
step
5. Build the Docker image with:
1. Build the Docker image with:
```
docker build -t fake-data-producer-for-apache-kafka-docker .
Expand All @@ -75,13 +73,13 @@ To start using the generator:
rebuild the Docker image to start using them.
:::
6. Start the streaming data flow with:
1. Start the streaming data flow with:
```
docker run fake-data-producer-for-apache-kafka-docker
```
7. Once the Docker image is running, check in the target Aiven for
1. Once the Docker image is running, check in the target Aiven for
Apache Kafka® service that the topic is populated. This can be done
with the [Aiven Console](https://console.aiven.io/), if the Kafka
REST option is enabled, in the *Topics* tab. Alternatively you can
Expand Down
7 changes: 3 additions & 4 deletions docs/products/kafka/kafka-connect/howto/http-sink.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: Create a sink connector from Apache Kafka® via HTTP
---

The HTTP sink connector enables you to move data from an Aiven for
Apache Kafka® cluster to a remote server via HTTP. The full list of
parameters and setup details is available in the [dedicated GitHub
repository](https://github.com/aiven/http-connector-for-apache-kafka/).
The HTTP sink connector enables you to move data from an Aiven for Apache Kafka® cluster to a remote server via HTTP.

The full list of parameters and setup details is available in the [dedicated GitHub repository](https://github.com/aiven/http-connector-for-apache-kafka/).

:::note
See the full set of available parameters and configuration
Expand Down
4 changes: 1 addition & 3 deletions docs/products/kafka/kafka-connect/howto/opensearch-sink.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: Create a sink connector from Apache Kafka® to OpenSearch®
---

The OpenSearch sink connector enables you to move data from an Aiven for
Apache Kafka® cluster to an OpenSearch® instance for further processing
and analysis.
The OpenSearch sink connector enables you to move data from an Aiven for Apache Kafka® cluster to an OpenSearch® instance for further processing and analysis.

<!-- vale off -->
:::warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
title: Active-passive setup
---

In this setup, there are two Apache Kafka® clusters, the primary and secondary clusters.
The primary cluster contains the *topic* topic. The
"active" cluster serves all produce and consume requests, while the
"passive" cluster serves as a replica of the "active" cluster
without running any applications against it.
In this setup, there are two Apache Kafka® clusters, the primary and secondary clusters. The primary cluster contains the *topic* topic.
The "active" cluster serves all produce and consume requests, while the "passive" cluster serves as a replica of the "active" cluster without running any applications against it.

![MirrorMaker 2 Active-Passive Setup](/images/content/products/kafka/kafka-mirrormaker/Mirrormaker-Active-Passive.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@
title: MirrorMaker 2 common parameters
---

MirrorMaker 2 (MM2) offers a suite of parameters to help with data
replication and monitoring within Apache Kafka® ecosystems. This topic
outlines common parameters you can adjust, along with tips for
MirrorMaker 2 (MM2) offers a suite of parameters to help with data replication and monitoring within Apache Kafka® ecosystems.
This topic outlines common parameters you can adjust, along with tips for
validating MM2's performance.

1. Increase the value of `kafka_mirrormaker.tasks_max_per_cpu` in the
advanced options. Setting this to match the number of partitions can
enhance performance.
2. Ensure the interval seconds for the following settings match. You
1. Ensure the interval seconds for the following settings match. You
can reduce these intervals for more frequent data synchronization:
- Advanced options:
- `kafka_mirrormaker.emit_checkpoints_interval_seconds`
- `kafka_mirrormaker.sync_group_offsets_interval_seconds`
- Replication flow:
- `Sync interval in seconds`.
3. To exclude internal topics, add these patterns to your topic
1. To exclude internal topics, add these patterns to your topic
blacklist:
- `.*[\-\.]internal` `.*\.replica` `__.*` `connect.*`
4. Depending on your use case, consider adjusting these parameters:
1. Depending on your use case, consider adjusting these parameters:
- `kafka_mirrormaker.consumer_fetch_min_bytes`
- `kafka_mirrormaker.producer_batch_size`
- `kafka_mirrormaker.producer_buffer_memory`
Expand All @@ -34,11 +33,11 @@ these:

1. **Consumer lag metric**: Monitor the `kafka.consumer_lag` metric.

2. **Dashboard metrics**: If MirrorMaker 2 stops adding records to a
1. **Dashboard metrics**: If MirrorMaker 2 stops adding records to a
topic, the `jmx.kafka.connect.mirror.record_count` metric stops
increasing, showing a flat line on the dashboard.

3. **Retrieve latest messages with \`kt\`**: Use
1. **Retrieve latest messages with \`kt\`**: Use
[kt](https://github.com/fgeller/kt) to retrieve the latest messages
from all partitions with the following command:

Expand Down
4 changes: 1 addition & 3 deletions docs/products/kafka/karapace/concepts/acl-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
title: ACLs definition
---

An ACL for Karapace schema registry authorization consists of zero or
more entries that specify a **username**, an **operation**, and a
**resource**.
An ACL for Karapace schema registry authorization consists of zero or more entries that specify a **username**, an **operation**, and a **resource**.

- **Username** is the name of a service user in the Aiven for Apache
Kafka® service.
Expand Down
8 changes: 2 additions & 6 deletions docs/products/mysql/concepts/max-number-of-connections.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
---
title: MySQL max_connections
service_label: max_connections
---

## `max_connections` vs RAM

The maximum number of simultaneous connections in Aiven for MySQL®
depends on how much RAM your service plan offers and is fixed for each
service plan (**Hobbyist**, **Startup**, **Business**, **Premium**, or
any other plan available under a specific cloud provider.)
The maximum number of simultaneous connections in Aiven for MySQL® depends on how much RAM your [service plan](/docs/platform/howto/scale-services) offers and is fixed for each service plan.

:::note
Independent of the plan, an `extra_connection` with a value of `1` is
Expand Down
4 changes: 2 additions & 2 deletions docs/products/mysql/concepts/mysql-backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Understand MySQL backups
sidebar_label: Backups
---

Aiven for MySQL databases are automatically backed-up, with full backups
daily, and binary logs recorded continuously. The number of stored
Aiven for MySQL databases are automatically backed-up, with full backups daily, and binary logs recorded continuously.
The number of stored
backups and backup retention time depends on your [Aiven service
plan](https://aiven.io/pricing?product=mysql&tab=plan-comparison). Full
backups are version-specific binary backups, which when combined with
Expand Down
3 changes: 2 additions & 1 deletion docs/products/mysql/howto/connect-from-cli.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Connect to Aiven for MySQL® from the command line
sidebar_label: Connect with the CLI
---

Connect to your MySQL via the command line with the following tools:
Connect to your Aiven for MySQL® service via the command line with the following tools:

- [mysqlsh shell](/docs/products/mysql/howto/connect-from-cli#connect-mysqlsh)
- [mysql client](/docs/products/mysql/howto/connect-from-cli#connect-mysql)
Expand Down
3 changes: 1 addition & 2 deletions docs/products/mysql/howto/connect-with-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ title: Connect to Aiven for MySQL® with PHP
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource1 from '!!raw-loader!/code/products/mysql/connect.php';

This example connects to an Aiven for MySQL® service from PHP, making
use of the built-in PDO module.
This example connects to an Aiven for MySQL® service from PHP, making use of the built-in PDO module.

## Variables

Expand Down
2 changes: 2 additions & 0 deletions docs/products/mysql/howto/list-code-samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ title: Connect to your Aiven for MySQL® service

import DocCardList from '@theme/DocCardList';

Discover the various ways to connect to your Aiven for MySQL® service.

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: OpenSearch® vs Elasticsearch
---

OpenSearch® is the open source continuation of the original Elasticsearch project.
When [Elastic moved to a restrictive license](https://www.elastic.co/blog/licensing-change), the changes
meant that third parties were not able to continue to offer
Elasticsearch as a service. The community (including Aiven) joined
OpenSearch® is the open-source version of the Elasticsearch project, which has [a restrictive license](https://www.elastic.co/blog/licensing-change). Third parties cannot offer Elasticsearch as a service.

The community (including Aiven) joined
forces to create and maintain OpenSearch based on the last open source
licensed releases of both Elasticsearch and Kibana (v7.10.2).

Expand Down
6 changes: 2 additions & 4 deletions docs/products/postgresql/concepts/dba-tasks-pg.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: Perform DBA-type tasks in Aiven for PostgreSQL®
sidebar_label: DBA-type tasks
---

Aiven doesn't allow superuser access to Aiven for PostgreSQL® services.
However, most DBA-type actions are still available through other
methods.
Aiven doesn't allow superuser access to Aiven for PostgreSQL® services. However, most DBA-type actions are still available through other methods.

## `avnadmin` user privileges

Expand Down Expand Up @@ -41,7 +39,7 @@ the `avnadmin` to perform superuser-like functionalities like:
You can install the `aiven_extras` extension executing the following
command with the `avnadmin` user:

```
```sql
CREATE EXTENSION aiven_extras CASCADE;
```

Expand Down
8 changes: 3 additions & 5 deletions docs/products/postgresql/concepts/timescaledb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
title: About TimescaleDB
---

[TimescaleDB](https://github.com/timescale/timescaledb) is an
open-source database designed to make your existing relational database
scalable for time series data. TimescaleDB is available as a PostgreSQL®
extension on Aiven.
[TimescaleDB](https://github.com/timescale/timescaledb) is an open-source database designed to make your existing relational database scalable for time series data.
TimescaleDB is available as a PostgreSQL® extension on Aiven.

A time series indexes a series of data points in chronological order,
usually as a sequence over regular intervals. Examples of a time series
Expand All @@ -22,7 +20,7 @@ took place.

TimescaleDB is available as an extension; you can enable it by running:

```
```sql
CREATE EXTENSION timescaledb CASCADE;
```

Expand Down
Loading

0 comments on commit c5ee83d

Please sign in to comment.