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

Reduce the number of redirected link errors #1547

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion SEARCH.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In addition to these `url` field should be provided with every document but it i

## Search function

The OpenSearch® index is used through the Netlify function in [netlify/functions/search/search.js](netlify/functions/search/search.js). To call the function, make a GET request to the function URL and append your search term to the `query` parameter, like this: [https://developer.aiven.io/.netlify/functions/search?query=redis](https://developer.aiven.io/.netlify/functions/search?query=redis).
The OpenSearch® index is used through the Netlify function in [netlify/functions/search/search.js](netlify/functions/search/search.js). To call the function, make a GET request to the function URL and append your search term to the `query` parameter, like this: [https://docs.aiven.io/.netlify/functions/search?query=redis](https://docs.aiven.io/.netlify/functions/search?query=redis).

The query uses this overall approach:

Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
html_baseurl = 'https://docs.aiven.io'
# Since we have `language='en'` set (further down) the URLs in the sitemap will
# default to "{version}{lang}{link}", producing things like
# <url><loc>https://developer.aiven.io/en/docs/platform/howto/create_authentication_token.html</loc></url>
# <url><loc>https://docs.aiven.io/en/docs/platform/howto/create_authentication_token.html</loc></url>
# That doesn't work because we do not produce pages with the `/en` in the URL.
# We need to be explicit that we don't want {version} or {language} in the URLs
sitemap_url_scheme = "{link}"
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Learn about some of the key concepts for working with Aiven platform:

.. We would like to use a :doc: role for this, but at 2022-08, vale will
spell-check the URL if we do so, and complain about 'timeseries'
.. _`Choosing a time series database`: https://developer.aiven.io/docs/platform/concepts/choosing-timeseries-database
.. _`Choosing a time series database`: https://docs.aiven.io/docs/platform/concepts/choosing-timeseries-database



Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Rotating Grafana® service credentials
In the interests of security, it is best practice to rotate credentials from time-to-time.

For Grafana®, a few steps need to be performed manually to do this. You will need to have access to a web browser,
and to have installed ``avn``, the `Aiven CLI tool <https://developer.aiven.io/docs/tools/cli.html>`_.
and to have installed ``avn``, the `Aiven CLI tool <https://docs.aiven.io/docs/tools/cli.html>`_.

1. In the web browser, go to the `Aiven Console <https://console.aiven.io/>`_ page for your Grafana service.

Expand Down
22 changes: 11 additions & 11 deletions docs/products/grafana/reference/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Clock - `Grafana <https://grafana.com/grafana/plugins/grafana-clock-panel/>`__ |
D3 Gauge - `Grafana <https://grafana.com/grafana/plugins/briangann-gauge-panel/>`__ | `GitHub <https://github.com/briangann/grafana-gauge-panel>`__
Provides a D3-based gauge panel for Grafana 6.x/7.x

Dashboard list - `Grafana <https://grafana.com/grafana/plugins/dashlist/>`__ | `Grafana Docs <http://docs.grafana.org/reference/dashlist/>`__
Dashboard list - `Grafana <https://grafana.com/grafana/plugins/dashlist/>`__ | `Grafana Docs <https://docs.grafana.org/reference/dashlist/>`__
Allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, a search query and/or dashboard tags.

Diagram - `Grafana <https://grafana.com/grafana/plugins/jdbranham-diagram-panel/>`__ | `GitHub <https://github.com/jdbranham/grafana-diagram>`__
Expand All @@ -56,7 +56,7 @@ Getting Started
Graph - `Grafana Docs <https://grafana.com/docs/grafana/latest/features/panels/graph/>`__
Included with Grafana, provides a very rich set of graphing options.

Heatmap - `Grafana <https://grafana.com/grafana/plugins/heatmap/>`__ | `Grafana Docs <http://docs.grafana.org/features/panels/heatmap/>`__
Heatmap - `Grafana <https://grafana.com/grafana/plugins/heatmap/>`__ | `Grafana Docs <https://docs.grafana.org/features/panels/heatmap/>`__
Allows you to view histograms over time.

Histogram - `Grafana <https://grafana.com/grafana/plugins/mtanda-histogram-panel/>`__ | `GitHub <https://github.com/mtanda/grafana-histogram-panel>`__
Expand All @@ -83,7 +83,7 @@ Plugin list - `Grafana <https://grafana.com/grafana/plugins/pluginlist/>`__
Singlestat Math - `Grafana <https://grafana.com/grafana/plugins/blackmirror1-singlestat-math-panel/>`__
A modification of the native single stat panel to support math functions across series.

Stat - `Grafana Docs <http://docs.grafana.org/reference/singlestat/>`__
Stat - `Grafana Docs <https://docs.grafana.org/reference/singlestat/>`__
Included with Grafana, allows you to show the one main summary stat of a SINGLE series.

State timeline
Expand Down Expand Up @@ -122,10 +122,10 @@ Altinity plugin for ClickHouse® - `GitHub <https://github.com/Altinity/clickhou
Azure Monitor - `Grafana <https://grafana.com/grafana/plugins/grafana-azure-monitor-datasource/>`__ | `GitHub <https://github.com/grafana/azure-monitor-datasource>`__
Provides a single source for monitoring Azure resources.

CloudWatch - `Grafana <https://grafana.com/grafana/plugins/cloudwatch/>`__ | `Grafana Docs <http://docs.grafana.org/datasources/cloudwatch/>`__
CloudWatch - `Grafana <https://grafana.com/grafana/plugins/cloudwatch/>`__ | `Grafana Docs <https://docs.grafana.org/datasources/cloudwatch/>`__
Build dashboards for your CloudWatch metrics.

Elasticsearch - `Grafana <https://grafana.com/grafana/plugins/elasticsearch/>`__ | `Grafana Docs <http://docs.grafana.org/datasources/elasticsearch/>`__
Elasticsearch - `Grafana <https://grafana.com/grafana/plugins/elasticsearch/>`__ | `Grafana Docs <https://docs.grafana.org/datasources/elasticsearch/>`__
Performs Elasticsearch queries to visualize logs or metrics stored in Elasticsearch. Annotate your graphs with log events stored in Elasticsearch.

GitHub - `GitHub <https://github.com/grafana/github-datasource>`__
Expand All @@ -137,10 +137,10 @@ Google BigQuery - `GitHub <https://github.com/doitintl/bigquery-grafana>`__
Google Sheets - `Grafana <https://grafana.com/grafana/plugins/grafana-googlesheets-datasource/>`__ | `GitHub <https://github.com/grafana/google-sheets-datasource>`__
Visualize your Google Spreadsheets in Grafana.

Graphite - `Grafana <https://grafana.com/grafana/plugins/graphite/>`__ | `Grafana Docs <http://docs.grafana.org/datasources/graphite/>`__
Graphite - `Grafana <https://grafana.com/grafana/plugins/graphite/>`__ | `Grafana Docs <https://docs.grafana.org/datasources/graphite/>`__
Quickly navigate the metric space, add functions, change function parameters and more.

InfluxDB® - `Grafana <https://grafana.com/grafana/plugins/influxdb/>`__ | `Grafana Docs <http://docs.grafana.org/datasources/influxdb/>`__
InfluxDB® - `Grafana <https://grafana.com/grafana/plugins/influxdb/>`__ | `Grafana Docs <https://docs.grafana.org/datasources/influxdb/>`__

Instana - `Grafana <https://grafana.com/grafana/plugins/instana-datasource/>`__ | `GitHub <https://github.com/instana/instana-grafana-datasource>`__
Shows metrics from Instana AI-Powered APM for dynamic applications.
Expand All @@ -154,22 +154,22 @@ Loki
Microsoft SQL Server
Grafana ships with a built-in Microsoft SQL Server (MSSQL) data source plugin that allows you to query and visualize data from any Microsoft SQL Server 2005 or newer.

MySQL - `Grafana <https://grafana.com/grafana/plugins/mysql/>`__ | `Grafana Docs <http://docs.grafana.org/features/datasources/mysql/>`__
MySQL - `Grafana <https://grafana.com/grafana/plugins/mysql/>`__ | `Grafana Docs <https://docs.grafana.org/features/datasources/mysql/>`__
Allows you to query any visualize data from a MySQL compatible database.

OpenSearch® - `Grafana <https://grafana.com/grafana/plugins/grafana-opensearch-datasource/>`__
Runs many types of simple or complex OpenSearch queries to visualize logs or metrics stored in OpenSearch. Annotate your graphs with log events stored in OpenSearch.

OpenTSDB - `Grafana <https://grafana.com/grafana/plugins/opentsdb/>`__ | `Grafana Docs <http://docs.grafana.org/datasources/opentsdb/>`__
OpenTSDB - `Grafana <https://grafana.com/grafana/plugins/opentsdb/>`__ | `Grafana Docs <https://docs.grafana.org/datasources/opentsdb/>`__
OpenTSDB is a scalable, distributed time series database.

Pagerduty - `Grafana <https://grafana.com/grafana/plugins/xginn8-pagerduty-datasource/>`__ | `GitHub <https://github.com/xginn8/grafana-pagerduty>`__
Annotations-only datasource for Pagerduty events.

PostgreSQL® - `Grafana <https://grafana.com/grafana/plugins/postgres/>`__ | `Grafana Docs <http://docs.grafana.org/features/datasources/postgres/>`__
PostgreSQL® - `Grafana <https://grafana.com/grafana/plugins/postgres/>`__ | `Grafana Docs <https://docs.grafana.org/features/datasources/postgres/>`__
Allows you to query and visualize data from a PostgreSQL compatible database.

Prometheus - `Grafana <https://grafana.com/grafana/plugins/prometheus/>`__ | `Grafana Docs <http://docs.grafana.org/datasources/prometheus/>`__
Prometheus - `Grafana <https://grafana.com/grafana/plugins/prometheus/>`__ | `Grafana Docs <https://docs.grafana.org/datasources/prometheus/>`__
Work with the open-source service monitoring system and time series database.

Prometheus AlertManager - `GitHub <https://github.com/camptocamp/grafana-prometheus-alertmanager-datasource>`__
Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Apache Kafka resources

If you are new to Apache Kafka, try these resources to learn more:

* The main Apache Kafka project page: http://kafka.apache.org/
* The main Apache Kafka project page: https://kafka.apache.org/

* The Karapace schema registry that Aiven maintains and makes available for every Aiven for Apache Kafka service: https://karapace.io/

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/concepts/auth-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Transport Layer Security
**Transport Layer Security (TLS)**, also known as Secure Sockets
Layer (SSL), is an established standard for securing internet traffic. This method
relies on a certificate that is provided by a Certificate
Authority (for example, `letsencrypt.org <http://letsencrypt.org>`_ ) for your domain.
Authority (for example, `letsencrypt.org <https://letsencrypt.org>`_ ) for your domain.
With this certificate and the right technical setup, you can use
your domain to encrypt the traffic to your service.

Expand Down
4 changes: 2 additions & 2 deletions docs/products/kafka/howto/connect-with-command-line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Variable Description

.. _`the guide to set up properties to use the Apache Kafka toolbox`: toolbox_
.. _`for Apache Kafka toolbox`: toolbox_
.. _toolbox: https://developer.aiven.io/docs/products/kafka/howto/kafka-tools-config-file.html
.. _toolbox: https://docs.aiven.io/docs/products/kafka/howto/kafka-tools-config-file.html

In the command lines below, values in ``{`` and ``}`` are to be replaced - so ``{PORT}`` would be replaced by the appropriate port number, for instance ``12345``.

Expand Down Expand Up @@ -65,7 +65,7 @@ With ``kafka-avro-console-producer`` you can include the schema by connecting to

1. The ``schema.registry.url`` value must be a full URL, typically starting with ``https://``
2. Aiven's `Karapace <https://karapace.io/>`_ is an acceptable schema registry for this purpose.
See `Use Karapace with Aiven for Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/enable-karapace.html>`_ for how to enable it for your Aiven for Kafka service. The ``SCHEMA_REGISTRY_`` values for the command line can be found on the service Overview page, on the **Schema registry** tab.
See `Use Karapace with Aiven for Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/enable-karapace.html>`_ for how to enable it for your Aiven for Kafka service. The ``SCHEMA_REGISTRY_`` values for the command line can be found on the service Overview page, on the **Schema registry** tab.

.. code::

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/connect-with-go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/connect-with-java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/connect-with-nodejs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand Down
6 changes: 3 additions & 3 deletions docs/products/kafka/howto/connect-with-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ These examples show how to connect to an Aiven for Apache Kafka® service using

.. note:: The examples given here provide different options for the different authentication
methods. For more information on the supported methods, see `our article on Kafka
authentication types <https://developer.aiven.io/docs/products/kafka/concepts/auth-types>`_.
authentication types <https://docs.aiven.io/docs/products/kafka/concepts/auth-types>`_.

Pre-requisites
--------------
Expand All @@ -35,7 +35,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand All @@ -48,7 +48,7 @@ Note that the *CA Certificate* ``ca.pem`` file has the same contents by either r

In the below examples, we just pass the name of the certificate files, but in actual use, the full path should be used.

You can also use the `Aiven command line tool <https://developer.aiven.io/docs/tools/cli.html>`_ to download the files. See the documentation for `avn service user-creds-download <https://developer.aiven.io/docs/tools/cli/service/user.html#avn-service-user-creds-download>`_
You can also use the `Aiven command line tool <https://docs.aiven.io/docs/tools/cli.html>`_ to download the files. See the documentation for `avn service user-creds-download <https://docs.aiven.io/docs/tools/cli/service/user.html#avn-service-user-creds-download>`_


Variables
Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/flink-with-aiven-for-kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The example in this article shows you how to create a simple Java Flink job that
Prerequisites
-------------

You need an Aiven for Apache Kafka service up and running with two topics, named ``test-flink-input`` and ``test-flink-output``, already `created <https://developer.aiven.io/docs/products/kafka/howto/create-topic.html>`_.
You need an Aiven for Apache Kafka service up and running with two topics, named ``test-flink-input`` and ``test-flink-output``, already `created <https://docs.aiven.io/docs/products/kafka/howto/create-topic.html>`_.
Furthermore, for the example, you need to collect the following information about the Aiven for Apache Kafka service:

* ``APACHE_KAFKA_HOST``: The hostname of the Apache Kafka service
Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/ksql-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Use ksqlDB with Aiven for Apache Kafka®

Aiven provides a managed Apache Kafka® solution together with a number of auxiliary services like Apache Kafka Connect, Kafka REST and Schema Registry via `Karapace <https://github.com/aiven/karapace>`_. A managed `ksqlDB <https://ksqldb.io/>`_ service in Aiven is, however, not supported. If you want to define streaming data pipelines with SQL, you have two options:

* Use `Aiven for Apache Flink® <https://developer.aiven.io/docs/products/flink.html>`_
* Use `Aiven for Apache Flink® <https://docs.aiven.io/docs/products/flink.html>`_
* Run a self-hosted ksqlDB cluster.


Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/kafka-connect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Apache Kafka® Connect resources

If you are new to Apache Kafka Connect, try these resources to learn more:

* The main Apache Kafka project page: http://kafka.apache.org/
* The main Apache Kafka project page: https://kafka.apache.org/

* The Karapace schema registry that Aiven maintains and makes available for every Aiven for Apache Kafka service: https://karapace.io/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Sink connectors enable the integration of data from an existing Apache Kafka top

* :doc:`Aiven for Apache Kafka® S3 Sink Connector <../howto/s3-sink-connector-aiven>`

* `Confluent Amazon S3 Sink <https://developer.aiven.io/docs/products/kafka/kafka-connect/howto/s3-sink-connector-confluent>`__
* `Confluent Amazon S3 Sink <https://docs.aiven.io/docs/products/kafka/kafka-connect/howto/s3-sink-connector-confluent>`__

* `Couchbase® <https://github.com/couchbase/kafka-connect-couchbase>`__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Furthermore you need to collect the following information about the source Postg
* ``PLUGIN_NAME``: The `logical decoding plugin <https://debezium.io/documentation/reference/stable/connectors/postgresql.html>`_, possible values are ``decoderbufs``, ``wal2json`` and ``pgoutput``
* ``PG_TABLES``: The list of database tables to be included in Apache Kafka; the list must be in the form of ``schema_name1.table_name1,schema_name2.table_name2``
* ``PG_PUBLICATION_NAME``: The name of the `PostgreSQL logical replication publication <https://www.postgresql.org/docs/current/logical-replication-publication.html>`_, if left empty, ``debezium`` is used as default
* ``PG_SLOT_NAME``: name of the `PostgreSQL replication slot <https://developer.aiven.io/docs/products/postgresql/howto/setup-logical-replication>`_, if left empty, ``debezium`` is be used as default
* ``PG_SLOT_NAME``: name of the `PostgreSQL replication slot <https://docs.aiven.io/docs/products/postgresql/howto/setup-logical-replication>`_, if left empty, ``debezium`` is be used as default
* ``APACHE_KAFKA_HOST``: The hostname of the Apache Kafka service, only needed when using Avro as data format
* ``SCHEMA_REGISTRY_PORT``: The Apache Kafka's schema registry port, only needed when using Avro as data format
* ``SCHEMA_REGISTRY_USER``: The Apache Kafka's schema registry username, only needed when using Avro as data format
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Metrics for Aiven for Apache Kafka® Connect available via Prometheus

Below you can find a summary of every metric available via Prometheus for an Aiven for Apache Kafka® Connect service. You can review the list of metrics available via Prometheus for the Aiven for Apache Kafka® service in the :doc:`dedicated document </docs/products/kafka/reference/kafka-metrics-prometheus>`.

A full description of the metrics is available in the `Connect Monitoring section of the Apache Kafka® documentation <http://kafka.apache.org/documentation/#connect_monitoring>`_.
A full description of the metrics is available in the `Connect Monitoring section of the Apache Kafka® documentation <https://kafka.apache.org/documentation/#connect_monitoring>`_.

.. Note::

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/kafka-mirrormaker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Apache Kafka® MirrorMaker 2 resources

If you are new to Apache Kafka® MirrorMaker 2, try these resources to learn more:

* The main Apache Kafka® project page: http://kafka.apache.org/
* The main Apache Kafka® project page: https://kafka.apache.org/

* The Karapace schema registry that Aiven maintains and makes available for every Aiven for Apache Kafka® service: https://karapace.io/

Expand Down
Loading