Skip to content

Commit

Permalink
fix: lint errors (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurFlag authored Jul 31, 2024
1 parent c710bf8 commit 333e716
Show file tree
Hide file tree
Showing 107 changed files with 430 additions and 501 deletions.
1 change: 0 additions & 1 deletion .github/vale/styles/Aiven/Generic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ level: error
ignorecase: true
tokens:
- click here
- follow the steps
- this article
- this guide
- this help article
Expand Down
1 change: 1 addition & 0 deletions .github/vale/styles/Aiven/Wordiness-error.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ action:
swap:
(?:if )?you want to: to
(?:take |apply )?(?:the )?following steps: nothing
(?:take |apply |follow )? these steps: nothing
and then: and
check it out: see
check out: see
Expand Down
12 changes: 6 additions & 6 deletions docs/integrations/datadog/add-custom-tags-to-datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Add custom tags Datadog integration
---

When using the Datadog integration in the [Aiven
Console](https://console.aiven.io/), Aiven automatically includes a set
of standard tags in all data sent to Datadog. These tags consist of:
`aiven-cloud:<cloud_name>`, `aiven-service-type:<service_type>`,
`aiven-service:<service_name>` and `aiven-project:<project_name>`.
When using the Datadog integration in the [Aiven Console](https://console.aiven.io/), Aiven automatically includes a set of standard tags in all data sent to Datadog.

These tags consist of: `aiven-cloud:<cloud_name>`,
`aiven-service-type:<service_type>`, `aiven-service:<service_name>` and
`aiven-project:<project_name>`.

In addition to the standard tags, you have the flexibility to include
your own custom tags, which will then be appended to the data sent to
Expand All @@ -22,7 +22,7 @@ to note that these tags apply exclusively to the specific integration or
connection being configured. Any tags configured at the endpoint level
will be included in addition to these tags.

To add tags to the endpoint, follow these steps:
To add tags to the endpoint:

1. Log in to [Aiven Console](https://console.aiven.io/), and select
**Integration endpoints**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Only Aiven for Apache Kafka® has support for Jolokia integration.

## Jolokia endpoint configuration

To enable Jolokia integration for Aiven services, follow these steps to
create a Jolokia endpoint configuration:
To enable Jolokia integration for Aiven services, create a Jolokia endpoint configuration:

1. Log in to the [Aiven console](https://console.aiven.io/) , and from
the **Services** page, select **Integration endpoints** on the left
Expand Down
3 changes: 1 addition & 2 deletions docs/platform/howto/integrations/prometheus-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,7 @@ metrics become available.

### Accessing Prometheus in a VPC

If you use a VPC in your project, follow these steps to access
Prometheus:
If you use a VPC in your project, access Prometheus:

1. Access [Aiven Console](https://console.aiven.io/).
1. Select your project, and select the service to monitor
Expand Down
7 changes: 3 additions & 4 deletions docs/platform/howto/migrate-services-vpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ title: Migrate a public service to a Virtual Private Cloud (VPC)

import ConsoleLabel from "@site/src/components/ConsoleIcons"

When operating your Aiven service over the public Internet, you might
consider enhancing security or connectivity by transitioning to a
Virtual Private Cloud (VPC, also known as VNet). This move allows you to
When operating your Aiven service over the public Internet, you might consider enhancing security or connectivity by transitioning to a Virtual Private Cloud (VPC, also known as VNet).
This move allows you to
restrict access and establish a more controlled environment between your
VPC and Aiven.

Expand Down Expand Up @@ -148,7 +147,7 @@ prefixed hostname and port.

## Conclusion

By following these steps, you can migrate services from public to VPC
You can migrate services from public to VPC
with minimal downtime, ensuring safe and tested connections throughout
the process. Always equip your client applications with failure and
retry logic to adapt to changes in servers and IP addresses. While this
Expand Down
3 changes: 1 addition & 2 deletions docs/platform/howto/saml/add-azure-idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ Go back to the Aiven Console to

## Troubleshooting

If you get an error message suggesting you contact your administrator,
try these steps:
If you get an error message suggesting you contact your administrator:

1. Go to the Microsoft Azure AD user profile for the users.
1. In **Contact Info**, check whether the **Email** field is blank.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/caching/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of minutes.

[Aiven CLI](https://github.com/aiven/aiven-client) provides a simple and
efficient way to create an Aiven for Caching service. If you prefer
launching a new service from the CLI, follow these steps:
launching a new service from the CLI:

1. Determine the service plan, cloud provider, and region to
use for your Caching service.
Expand Down
2 changes: 0 additions & 2 deletions docs/products/caching/howto/configure-acl-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import ConsoleLabel from "@site/src/components/ConsoleIcons"


Aiven for Caching uses [Access Control Lists (ACLs)](https://redis.io/docs/management/security/acl/) o manage the usage of commands and keys based on specific username and password combinations.
Direct use of [ACL commands](https://redis.io/commands/acl-list/) is restricted to
ensure the reliability of replication, configuration management, and disaster recovery
Expand Down Expand Up @@ -77,7 +76,6 @@ To create a user and configure ACLs using the Aiven CLI:
## User management

Manage users of your Aiven for Caching service directly from the Aiven Console.
Follow these steps for various user management tasks:

### Reset password

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ and require project VPC and peering connection.

## Migrate a Redis database

Follow these steps to migrate a Redis database to Aiven for Caching service:
To migrate a Redis database to Aiven for Caching service:

1. Log in to the [Aiven Console](https://console.aiven.io/), and select the target
Aiven for Caching service for migrating the Redis® database.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/caching/howto/warning-overcommit_memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ following **warning** `overcommit_memory`:
```plaintext
# WARNING overcommit_memory is set to 0! Background save may fail under
low memory condition. To fix this issue add
'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1'
'vm.overcommit_memory = 1' to /etc/sysctl.conf and reboot or run the command 'sysctl vm.overcommit_memory=1'
for this to take effect.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/products/dragonfly/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ of minutes.

[Aiven CLI](https://github.com/aiven/aiven-client) provides a simple and
efficient way to create an Aiven for Dragonfly® service. If you prefer
creating a new service from the CLI, follow these steps:
creating a new service from the CLI:

1. Determine the service plan, cloud provider, and region to
use for your Aiven for Dragonfly service.
Expand Down
4 changes: 2 additions & 2 deletions docs/products/flink/concepts/flink-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ encounter:
current version.
- **RESTARTING**: Your application is being restarted.
- **SAVING_AND_STOP**: Your application is currently saving its
current state in a savepoint and then stopping.
current state in a savepoint and stopping.

Other statuses and transient statuses include:

Expand All @@ -104,5 +104,5 @@ Other statuses and transient statuses include:
- **RESTARTING**: Your application is undergoing a restart process.
- **SAVING**: Your application is creating a savepoint.
- **SAVING_AND_STOP_REQUESTED**: A request has been made to save the
current state of your application in a savepoint and then stop it.
current state of your application in a savepoint and stop it.
- **SUSPENDED**: Your application has been suspended.
4 changes: 2 additions & 2 deletions docs/products/flink/howto/connect-bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ as a connector to connect to Google BigQuery.

## Configure integration using Aiven CLI

To configure integration using Aiven CLI, follow these steps:
To configure integration using Aiven CLI:

### Step 1: Create or use an Aiven for Apache Flink service

Expand Down Expand Up @@ -266,7 +266,7 @@ them back as shown in the example above).
If you're using Google BigQuery for your data storage and analysis, you
can seamlessly integrate it as a sink for Aiven for Apache Flink
streams. To achieve this via the [Aiven
Console](https://console.aiven.io/), follow these steps:
Console](https://console.aiven.io/):

1. Log in to [Aiven Console](https://console.aiven.io/) and choose your
project.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/flink/howto/create-jar-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Custom JARs enabled.
1. Access the [Aiven Console](https://console.aiven.io/) and select the
Aiven for Apache Flink service where you want to deploy a JAR
application.
1. From the left sidebar, click **Applications** and then click
1. From the left sidebar, click **Applications** and click
**Create application**.
1. In the **Create application** dialog, enter a name for your JAR
application, and select **JAR** as the application type from the
Expand Down
2 changes: 1 addition & 1 deletion docs/products/flink/howto/datagen-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Apache ®Flink application.
## Configure Datagen as source for Flink application

To configure DataGen as the source using the DataGen built-in connector
for Apache Flink, follow these steps:
for Apache Flink:

1. In the Aiven for Apache Flink service page, select **Application**
from the left sidebar.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/flink/howto/ext-kafka-flink-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Apache Kafka with Aiven for Apache Flink® using

## Configure integration using CLI

To configure integration using Aiven CLI, follow these steps:
To configure integration using Aiven CLI:

### Step 1. Create a Aiven for Apache Flink service

Expand Down
8 changes: 4 additions & 4 deletions docs/products/flink/howto/manage-flink-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Flink® applications.

## Creating a new version of an application

To create a version of the application deployed, follow these steps:
To create a version of the application deployed:

1. Log in to the [Aiven Console](https://console.aiven.io/), and select
your Aiven for Apache Flink® service.
Expand Down Expand Up @@ -49,7 +49,7 @@ To create a version of the application deployed, follow these steps:

## Stop an application deployment {#stop-flink-application}

To stop a deployment for your Flink application, follow these steps:
To stop a deployment for your Flink application:

1. In your Aiven for Apache Flink service, select **Applications** from
the left sidebar.
Expand All @@ -64,15 +64,15 @@ To stop a deployment for your Flink application, follow these steps:
savepoint**.
5. Click **Create savepoint & stop** to initiate the stopping process.

The application status will display `Saving_and_stop_requested` and then
The application status will display `Saving_and_stop_requested` and
`Finished` once the stopping process is completed.

Additionally, the **Deployment history** provides a record of all the
application deployments and statuses.

## Rename an application

To rename an application, follow these steps:
To rename an application:

1. In your Aiven for Apache Flink service, select **Applications** from
the left sidebar.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/flink/howto/pg-cdc-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Console](https://console.aiven.io/):
connecting user must have enough privileges to create it.
:::
7. Select **Next** to add the sink table, and then select **Add your
7. Select **Next** to add the sink table, and select **Add your
first sink table**. Select *Aiven for Apache Kafka®* as the
integrated service from the drop-down list.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/flink/howto/slack-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Flink®](https://github.com/aiven/slack-connector-for-apache-flink).
## Configure Slack as sink for Flink application

To configure Slack as the target using the Slack connector for Apache
Flink, follow these steps:
Flink:

1. In the Aiven for Apache Flink service page, select **Application**
from the left sidebar.
Expand Down
16 changes: 7 additions & 9 deletions docs/products/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@
title: Aiven for Grafana®
---

Aiven for Grafana® is a fully managed analytics and monitoring solution,
deployable in the cloud of your choice, which can bring unlimited
scalability and high availability to your monitoring environment and
other time series applications.
Aiven for Grafana® is a fully managed analytics and monitoring solution, deployable in the cloud of your choice, which can bring unlimited scalability and high availability to your monitoring environment and other time series applications.

## Main features

Expand All @@ -22,7 +19,7 @@ enabling you to meet strict control requirements.
### Integrate with existing Aiven tools and data infrastructure

Aiven for Grafana seamlessly integrates various services and your
existing Aiven tools. You can easily set up your Aiven services as data
existing Aiven tools. You can set up your Aiven services as data
sources for Grafana and monitor their health in real time. This
integration allows you to leverage the full potential of your data
infrastructure, making it easier to manage and monitor. In addition to
Expand All @@ -36,9 +33,9 @@ issues.

Aiven offers various options for secure network connectivity, including
[VPC peering](/docs/platform/howto/manage-vpc-peering),
[PrivateLink](/docs/tools/cli/service/privatelink), and TransitGateway technologies. These options allow you to
securely connect your data infrastructure to Aiven services and ensure
the highest level of data security.
[PrivateLink](/docs/tools/cli/service/privatelink), and TransitGateway
technologies. These options allow you to securely connect your data
infrastructure to Aiven services and ensure the highest level of data security.

### Log management

Expand All @@ -51,7 +48,8 @@ performance.
- **Dashboards and plugins:** With Aiven for Grafana, you can monitor
your data using ready-made dashboards. Benefit from over 60 advanced
panel and
[data source plugins](/docs/products/grafana/reference/plugins) that provide a high level of customization to your
[data source plugins](/docs/products/grafana/reference/plugins) that provide a
high level of customization to your
monitoring solution.
- **Monitoring and alerting:** Aiven for Grafana allows you to create
monitoring solutions for all teams, enabling everyone to keep track
Expand Down
3 changes: 1 addition & 2 deletions docs/products/grafana/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ of minutes.

## Log in to Grafana

After starting the Aiven for Grafana service, you can follow these steps
to access Grafana:
After starting the Aiven for Grafana service, you can access Grafana:

1. From the [Aiven Console](https://console.aiven.io/), access your
Aiven for Grafana service.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/grafana/howto/dashboard-previews.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Follow these steps to enable dashboard previews for your Aiven for
Grafana service:

1. In the [Aiven Console](https://console.aiven.io/), select your
project and then choose your Aiven for Grafana® service.
project and choose your Aiven for Grafana® service.

2. In the service page, select **Service settings** from the sidebar.

Expand Down
4 changes: 2 additions & 2 deletions docs/products/grafana/howto/replace-expression-string.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ dashboards.

To get your API key (`GRAFANA_API_KEY`):

- Go to your Grafana® UI. Select the **Configuration** icon and then
- Go to your Grafana® UI. Select the **Configuration** icon and
select the **API keys** tab

- If you already have an appropriate API key available, save a copy of
it.

- Otherwise, select **Add API key** and fill in the *Key name*, *Role*
and *Time to live*. Click **Add** and then save the new API key.
and *Time to live*. Click **Add** and save the new API key.

:::tip
*Role* must be either *Editor* or *Admin*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ the [Aiven CLI tool](https://docs.aiven.io/docs/tools/cli.html).

4. Change the password and make a note of it somewhere safe.

5. Login with `avn` and then run the following command to update the
5. Login with `avn` and run the following command to update the
stored password in the console:

```
Expand Down
Loading

0 comments on commit 333e716

Please sign in to comment.