Layout NG: Address suggestions by CodeRabbit

amotl · amotl · commit 6fb05a4546ba · 2025-08-09T19:05:18.000+02:00
diff --git a/docs/_include/card/timeseries-datashader.md b/docs/_include/card/timeseries-datashader.md
@@ -10,7 +10,9 @@ points from your backend systems to the browser's glass.
 This notebook plots the venerable NYC Taxi dataset after importing it
 into a CrateDB Cloud database cluster.
 
-🚧 _Please note this notebook is a work in progress._ 🚧
+```{todo}
+🚧 This notebook is a work in progress. 🚧
+```
 
 {{ '{}[cloud-datashader-github]'.format(nb_github) }} {{ '{}[cloud-datashader-colab]'.format(nb_colab) }}
 :::
diff --git a/docs/ingest/cdc/index.md b/docs/ingest/cdc/index.md
@@ -5,15 +5,15 @@
 :::
 
 :::{div}
-CrateDB provides a variety of options to connect and integrate with third-party
+CrateDB provides many options to connect and integrate with third-party
 CDC applications, mostly using [CrateDB's PostgreSQL interface].
-CrateDB also provides a few native adapter components that can be used
-to leverage its advanced features. 
+CrateDB also provides native adapter components to leverage advanced
+features.
 
 This documentation section lists corresponding CDC applications and
 frameworks which can be used together with CrateDB, and outlines how
 to use them optimally.
-Please also have a look at support for [generic ETL](#etl) solutions.
+Please also take a look at support for {ref}`generic ETL <etl>` solutions.
 :::
 
 - {ref}`aws-dms`
diff --git a/docs/ingest/etl/index.md b/docs/ingest/etl/index.md
@@ -7,15 +7,15 @@
 :::
 
 :::{div}
-CrateDB provides a variety of options to connect and integrate with third-party
+CrateDB provides many options to connect and integrate with third-party
 ETL applications, mostly using [CrateDB's PostgreSQL interface].
-CrateDB also provides a few native adapter components that can be used
-to leverage its advanced features.
+CrateDB also provides native adapter components to leverage advanced
+features.
 
 This documentation section lists corresponding ETL applications and
 frameworks which can be used together with CrateDB, and outlines how
 to use them optimally.
-Please also have a look at support for [](#cdc) solutions.
+Please also take a look at support for {ref}`cdc` solutions.
 :::
 
 
diff --git a/docs/integrate/apache-iceberg/index.md b/docs/integrate/apache-iceberg/index.md
@@ -12,7 +12,7 @@ CrateDB provides integration capabilities with Apache Iceberg implementations,
 see {ref}`risingwave-iceberg`.
 
 :::{todo}
-🚧 _Please note this page is a work in progress._ 🚧
+🚧 This page is a work in progress. 🚧
 :::
 
 
diff --git a/docs/integrate/aws-dms/index.md b/docs/integrate/aws-dms/index.md
@@ -14,8 +14,8 @@ service that helps move your database and analytics workloads between different
 kinds of databases quickly, securely, and with minimal downtime and zero data
 loss.
 
-AWS DMS supports migration between 20-plus database and analytics engines, either
-on-premises, or per EC2 instance databases. Supported data migration sources are:
+AWS DMS supports migration between 20+ database and analytics engines, either
+on-premises or on EC2-hosted databases. Supported data migration sources include:
 Amazon Aurora, Amazon DocumentDB, Amazon S3, IBM DB2, MariaDB, Azure SQL Database,
 Microsoft SQL Server, MongoDB, MySQL, Oracle, PostgreSQL, SAP ASE.
 :::
@@ -27,10 +27,9 @@ Microsoft SQL Server, MongoDB, MySQL, Oracle, PostgreSQL, SAP ASE.
 The [AWS DMS Integration with CrateDB] uses Amazon Kinesis Data Streams as
 a DMS target, combined with a CrateDB-specific downstream processor element.
 
-CrateDB provides two variants how to conduct data migrations using AWS DMS.
-Either use it standalone / on your own premises, or use it in a completely
-managed environment with services of AWS and CrateDB Cloud.
+CrateDB supports two ways to run AWS DMS migrations:
+Either standalone/on‑premises, or fully managed with AWS and CrateDB Cloud.
 
-AWS DMS supports both `full-load` and `cdc` operation modes, often used in
-combination with each other (`full-load-and-cdc`).
+AWS DMS supports both `full-load` and `cdc` operation modes, which are often
+combined (`full-load-and-cdc`).
 :::
diff --git a/docs/integrate/aws-kinesis/index.md b/docs/integrate/aws-kinesis/index.md
@@ -13,9 +13,9 @@ simplifies the capture, processing, and storage of data streams at any
 scale, such as application logs, website clickstreams, and IoT telemetry
 data, for machine learning (ML), analytics, and other applications.
 
-You can use Amazon Kinesis Data Streams to collect and process large streams of data
-records in real time. A typical Kinesis Data Streams application reads data from a
-data stream as data records.
+You can use Amazon Kinesis Data Streams to collect and process large data
+streams in real time. A typical application reads data from the stream as
+records.
 :::
 
 :::{rubric} Learn
@@ -24,5 +24,5 @@ data stream as data records.
 :::{div}
 The [DynamoDB CDC Relay] pipeline uses Amazon Kinesis to relay a table
 change stream from a DynamoDB table into a CrateDB table, see also
-[DynamoDB CDC](#cdc-dynamodb).
+{ref}`DynamoDB CDC <aws-dynamodb>`.
 :::
diff --git a/docs/integrate/cluvio/index.md b/docs/integrate/cluvio/index.md
@@ -6,7 +6,7 @@
 
 ```{div}
 :style: "float: right; margin-left: 1em"
-[![cluvio-logo-full_color-on_dark.svg ](https://github.com/crate/crate-clients-tools/assets/453543/cac142ef-412a-4a67-a63f-bf9d1ce92c84){w=180px}](https://www.cluvio.com/)
+[![cluvio-logo-full_color-on_dark.svg](https://github.com/crate/crate-clients-tools/assets/453543/cac142ef-412a-4a67-a63f-bf9d1ce92c84){w=180px}](https://www.cluvio.com/)
 ```
 
 [Cluvio] is a programmable and interactive dashboarding platform — your analytics
diff --git a/docs/integrate/influxdb/index.md b/docs/integrate/influxdb/index.md
@@ -1,4 +1,6 @@
 (influxdb)=
+(integrate-influxdb)=
+(integrate-influxdb-quickstart)=
 # InfluxDB
 
 :::{include} /_include/links.md
diff --git a/docs/integrate/influxdb/learn.md b/docs/integrate/influxdb/learn.md
@@ -1,5 +1,3 @@
-(integrate-influxdb)=
-(integrate-influxdb-quickstart)=
 (import-influxdb)=
 # Import data from InfluxDB
 
@@ -48,6 +46,8 @@ data in schemas and tables.
 - A **field** is similar to an un-indexed column in an SQL database.
 - A **point** is similar to an SQL row.
 
+-- [via][What are series and bucket in InfluxDB]
+
 ## Tutorial
 
 The tutorial heavily uses Docker to provide services and to run jobs.
@@ -131,25 +131,28 @@ alias crash="docker run --rm -it ghcr.io/crate/cratedb-toolkit:latest crash"
 You will need your credentials for both CrateDB and InfluxDB. 
 These are, with examples:
 
-**CrateDB Cloud**
-* Host: ```purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net```
-* Username: ```admin```
-* Password: ```dZ..qB```
+:::{rubric} CrateDB Cloud
+:::
+- Host: ```purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net```
+- Username: ```admin```
+- Password: ```dZ..qB```
 
-**InfluxDB Cloud**
-  * Host: ```eu-central-1-1.aws.cloud2.influxdata.com```
-  * Organization ID: ```9fafc869a91a3406```
-  * All-Access API token: ```T2..==```
+:::{rubric} InfluxDB Cloud
+:::
+- Host: ```eu-central-1-1.aws.cloud2.influxdata.com```
+- Organization ID: ```9fafc869a91a3406```
+- All-Access API token: ```T2..==```
 
 For CrateDB, the credentials are displayed at time of cluster creation.
 For InfluxDB, they can be found in the [cloud platform] itself.
 
 Now, same as before, import data from InfluxDB bucket/measurement into 
 CrateDB schema/table.
 :::{code} shell
+export CRATEPW='dZ..qB'
 ctk load table \
   "influxdb2://9f..06:T2..==@eu-central-1-1.aws.cloud2.influxdata.com/testdrive/demo?ssl=true" \
-  --cratedb-sqlalchemy-url="crate://admin:dZ..qB@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200/testdrive/demo?ssl=true"
+  --cratedb-sqlalchemy-url="crate://admin:${CRATEPW}@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200/testdrive/demo?ssl=true"
 :::
 
 ::: {note}
@@ -159,7 +162,8 @@ when working on Cloud-to-Cloud transfers.
 
 Verify that relevant data has been transferred to CrateDB.
 :::{code} shell
-crash --hosts 'https://admin:dZ..qB@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200' --command 'SELECT * FROM testdrive.demo;'
+export CRATEPW='dZ..qB'
+crash --hosts 'https://admin:${CRATEPW}@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200' --command 'SELECT * FROM testdrive.demo;'
 :::
 
 ## More information
@@ -168,9 +172,8 @@ There are more ways to apply the I/O subsystem of CrateDB Toolkit as
 pipeline elements in your daily data operations routines. Please visit the 
 [CrateDB Toolkit InfluxDB I/O subsystem] documentation, to learn more about what's possible.
 
-The InfluxDB I/O subsystem is based on the [influxio] package. Please also
-check its documentation to learn about more of its capabilities, supporting
-you when working with InfluxDB.
+The InfluxDB I/O subsystem is based on the [influxio] package. See its
+documentation for additional capabilities when working with InfluxDB.
 
 :::{note}
 **Important:** If you discover any issues with this adapter, please
diff --git a/docs/integrate/meltano/index.md b/docs/integrate/meltano/index.md
@@ -34,7 +34,9 @@ as Singer taps and targets.
 - [meltano-tap-cratedb]
 - [meltano-target-cratedb]
 
-🚧 _Please note these adapters are a work in progress._ 🚧
+:::{todo}
+🚧 These adapters are a work in progress. 🚧
+:::
 
 
 [Examples about working with CrateDB and Meltano]: https://github.com/crate/cratedb-examples/tree/amo/meltano/framework/singer-meltano
diff --git a/docs/integrate/mongodb/index.md b/docs/integrate/mongodb/index.md
@@ -9,7 +9,7 @@
 
 :::{div}
 [MongoDB] is a document database designed for ease of application development and scaling.
-[MongoDB Atlas] is a multi-cloud database service by the same people that build MongoDB.
+[MongoDB Atlas] is a multi-cloud database service by the same people who build MongoDB.
 Atlas simplifies deploying and managing your databases while offering the versatility
 you need to build resilient and performant global applications on the cloud providers
 of your choice.
diff --git a/docs/integrate/mysql/index.md b/docs/integrate/mysql/index.md
@@ -10,11 +10,24 @@
 
 ```{div}
 :style: "float: right; margin-left: 1em"
-[![cluvio-logo-full_color-on_dark.svg ](https://github.com/crate/crate-clients-tools/assets/453543/cac142ef-412a-4a67-a63f-bf9d1ce92c84){w=180px}](https://www.cluvio.com/)
+
+[![mysql-logo](https://labs.mysql.com/common/logos/mysql-logo.svg?v2){w=180px}](https://www.mysql.com/)
+<br><br>
+[![mariadb-logo](https://mariadb.com/wp-content/themes/mariadb-2025/public/images/logo-dark.4482a1.svg){w=180px}](https://www.mariadb.com/)
 ```
 
-[MySQL] and [MariaDB] are well-known OLTP databases, available as standalone and
-managed variants.
+[MySQL] and [MariaDB] are well-known free and open-source relational database
+management systems (RDBMS), available as standalone and managed variants.
+
+MySQL is a component of the LAMP web application software stack (and others),
+which is an acronym for Linux, Apache, MySQL, Perl/PHP/Python.
+
+In 2010, when Oracle acquired Sun, Monty Widenius, MySQL's founder, forked the
+open-source MySQL project to create MariaDB.
+
+```{div}
+:style: "clear: both"
+```
 
 :::{rubric} Learn
 :::
diff --git a/docs/integrate/risingwave/apache-iceberg.md b/docs/integrate/risingwave/apache-iceberg.md
@@ -1,3 +1,4 @@
+(iceberg-risingwave)=
 (risingwave-iceberg)=
 
 # Stream processing from Iceberg tables to CrateDB using RisingWave
diff --git a/docs/integrate/streamsets/index.md b/docs/integrate/streamsets/index.md
@@ -6,11 +6,11 @@
 
 The [StreamSets Data Collector] is a lightweight and powerful engine that
 allows you to build streaming, batch and change-data-capture (CDC) pipelines
-that can ingest and transform data from a variety of different sources.
+that can ingest and transform data from a variety of sources.
 
 StreamSets Data Collector Engine makes it easy to run data pipelines from Kafka,
 Oracle, Salesforce, JDBC, Hive, and more to Snowflake, Databricks, S3, ADLS, Kafka
-and more. Data Collector Engine runs on-premises or any cloud, wherever your data
+and more. Data Collector Engine runs on-premises or in any cloud, wherever your data
 lives.
 
 :::{rubric} Learn
