Skip to content

Commit c187654

Browse files
committed
Layout NG: Address suggestions by CodeRabbit
1 parent 3546bc4 commit c187654

File tree

13 files changed

+64
-42
lines changed

13 files changed

+64
-42
lines changed

docs/_include/card/timeseries-datashader.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ points from your backend systems to the browser's glass.
1010
This notebook plots the venerable NYC Taxi dataset after importing it
1111
into a CrateDB Cloud database cluster.
1212

13-
🚧 _Please note this notebook is a work in progress._ 🚧
13+
```{todo}
14+
🚧 This notebook is a work in progress. 🚧
15+
```
1416

1517
{{ '{}[cloud-datashader-github]'.format(nb_github) }} {{ '{}[cloud-datashader-colab]'.format(nb_colab) }}
1618
:::

docs/ingest/cdc/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
:::
66

77
:::{div}
8-
CrateDB provides a variety of options to connect and integrate with third-party
8+
CrateDB provides many options to connect and integrate with third-party
99
CDC applications, mostly using [CrateDB's PostgreSQL interface].
10-
CrateDB also provides a few native adapter components that can be used
11-
to leverage its advanced features.
10+
CrateDB also provides native adapter components to leverage advanced
11+
features.
1212

1313
This documentation section lists corresponding CDC applications and
1414
frameworks which can be used together with CrateDB, and outlines how
1515
to use them optimally.
16-
Please also have a look at support for [generic ETL](#etl) solutions.
16+
Please also take a look at support for {ref}`generic ETL <etl>` solutions.
1717
:::
1818

1919
- {ref}`aws-dms`

docs/ingest/etl/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
:::
88

99
:::{div}
10-
CrateDB provides a variety of options to connect and integrate with third-party
10+
CrateDB provides many options to connect and integrate with third-party
1111
ETL applications, mostly using [CrateDB's PostgreSQL interface].
12-
CrateDB also provides a few native adapter components that can be used
13-
to leverage its advanced features.
12+
CrateDB also provides native adapter components to leverage advanced
13+
features.
1414

1515
This documentation section lists corresponding ETL applications and
1616
frameworks which can be used together with CrateDB, and outlines how
1717
to use them optimally.
18-
Please also have a look at support for [](#cdc) solutions.
18+
Please also take a look at support for {ref}`cdc` solutions.
1919
:::
2020

2121

docs/integrate/apache-iceberg/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CrateDB provides integration capabilities with Apache Iceberg implementations,
1212
see {ref}`risingwave-iceberg`.
1313

1414
:::{todo}
15-
🚧 _Please note this page is a work in progress._ 🚧
15+
🚧 This page is a work in progress. 🚧
1616
:::
1717

1818

docs/integrate/aws-dms/index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ service that helps move your database and analytics workloads between different
1414
kinds of databases quickly, securely, and with minimal downtime and zero data
1515
loss.
1616

17-
AWS DMS supports migration between 20-plus database and analytics engines, either
18-
on-premises, or per EC2 instance databases. Supported data migration sources are:
17+
AWS DMS supports migration between 20+ database and analytics engines, either
18+
on-premises or on EC2-hosted databases. Supported data migration sources include:
1919
Amazon Aurora, Amazon DocumentDB, Amazon S3, IBM DB2, MariaDB, Azure SQL Database,
2020
Microsoft SQL Server, MongoDB, MySQL, Oracle, PostgreSQL, SAP ASE.
2121
:::
@@ -27,10 +27,9 @@ Microsoft SQL Server, MongoDB, MySQL, Oracle, PostgreSQL, SAP ASE.
2727
The [AWS DMS Integration with CrateDB] uses Amazon Kinesis Data Streams as
2828
a DMS target, combined with a CrateDB-specific downstream processor element.
2929

30-
CrateDB provides two variants how to conduct data migrations using AWS DMS.
31-
Either use it standalone / on your own premises, or use it in a completely
32-
managed environment with services of AWS and CrateDB Cloud.
30+
CrateDB supports two ways to run AWS DMS migrations:
31+
Either standalone/on‑premises, or fully managed with AWS and CrateDB Cloud.
3332

34-
AWS DMS supports both `full-load` and `cdc` operation modes, often used in
35-
combination with each other (`full-load-and-cdc`).
33+
AWS DMS supports both `full-load` and `cdc` operation modes, which are often
34+
combined (`full-load-and-cdc`).
3635
:::

docs/integrate/aws-kinesis/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ simplifies the capture, processing, and storage of data streams at any
1313
scale, such as application logs, website clickstreams, and IoT telemetry
1414
data, for machine learning (ML), analytics, and other applications.
1515

16-
You can use Amazon Kinesis Data Streams to collect and process large streams of data
17-
records in real time. A typical Kinesis Data Streams application reads data from a
18-
data stream as data records.
16+
You can use Amazon Kinesis Data Streams to collect and process large data
17+
streams in real time. A typical application reads data from the stream as
18+
records.
1919
:::
2020

2121
:::{rubric} Learn
@@ -24,5 +24,5 @@ data stream as data records.
2424
:::{div}
2525
The [DynamoDB CDC Relay] pipeline uses Amazon Kinesis to relay a table
2626
change stream from a DynamoDB table into a CrateDB table, see also
27-
[DynamoDB CDC](#cdc-dynamodb).
27+
{ref}`DynamoDB CDC <aws-dynamodb>`.
2828
:::

docs/integrate/cluvio/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
```{div}
88
:style: "float: right; margin-left: 1em"
9-
[![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/)
9+
[![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/)
1010
```
1111

1212
[Cluvio] is a programmable and interactive dashboarding platform — your analytics

docs/integrate/influxdb/learn.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ data in schemas and tables.
4848
- A **field** is similar to an un-indexed column in an SQL database.
4949
- A **point** is similar to an SQL row.
5050

51+
-- [via][What are series and bucket in InfluxDB]
52+
5153
## Tutorial
5254

5355
The tutorial heavily uses Docker to provide services and to run jobs.
@@ -131,25 +133,28 @@ alias crash="docker run --rm -it ghcr.io/crate/cratedb-toolkit:latest crash"
131133
You will need your credentials for both CrateDB and InfluxDB.
132134
These are, with examples:
133135

134-
**CrateDB Cloud**
135-
* Host: ```purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net```
136-
* Username: ```admin```
137-
* Password: ```dZ..qB```
136+
:::{rubric} CrateDB Cloud
137+
:::
138+
- Host: ```purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net```
139+
- Username: ```admin```
140+
- Password: ```dZ..qB```
138141

139-
**InfluxDB Cloud**
140-
* Host: ```eu-central-1-1.aws.cloud2.influxdata.com```
141-
* Organization ID: ```9fafc869a91a3406```
142-
* All-Access API token: ```T2..==```
142+
:::{rubric} InfluxDB Cloud
143+
:::
144+
- Host: ```eu-central-1-1.aws.cloud2.influxdata.com```
145+
- Organization ID: ```9fafc869a91a3406```
146+
- All-Access API token: ```T2..==```
143147

144148
For CrateDB, the credentials are displayed at time of cluster creation.
145149
For InfluxDB, they can be found in the [cloud platform] itself.
146150

147151
Now, same as before, import data from InfluxDB bucket/measurement into
148152
CrateDB schema/table.
149153
:::{code} shell
154+
export CRATEPW='dZ..qB'
150155
ctk load table \
151156
"influxdb2://9f..06:T2..==@eu-central-1-1.aws.cloud2.influxdata.com/testdrive/demo?ssl=true" \
152-
--cratedb-sqlalchemy-url="crate://admin:dZ..qB@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200/testdrive/demo?ssl=true"
157+
--cratedb-sqlalchemy-url="crate://admin:${CRATEPW}@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200/testdrive/demo?ssl=true"
153158
:::
154159

155160
::: {note}
@@ -159,7 +164,8 @@ when working on Cloud-to-Cloud transfers.
159164

160165
Verify that relevant data has been transferred to CrateDB.
161166
:::{code} shell
162-
crash --hosts 'https://admin:dZ..qB@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200' --command 'SELECT * FROM testdrive.demo;'
167+
export CRATEPW='dZ..qB'
168+
crash --hosts 'https://admin:${CRATEPW}@purple-shaak-ti.eks1.eu-west-1.aws.cratedb.net:4200' --command 'SELECT * FROM testdrive.demo;'
163169
:::
164170

165171
## More information
@@ -168,9 +174,8 @@ There are more ways to apply the I/O subsystem of CrateDB Toolkit as
168174
pipeline elements in your daily data operations routines. Please visit the
169175
[CrateDB Toolkit InfluxDB I/O subsystem] documentation, to learn more about what's possible.
170176

171-
The InfluxDB I/O subsystem is based on the [influxio] package. Please also
172-
check its documentation to learn about more of its capabilities, supporting
173-
you when working with InfluxDB.
177+
The InfluxDB I/O subsystem is based on the [influxio] package. See its
178+
documentation for additional capabilities when working with InfluxDB.
174179

175180
:::{note}
176181
**Important:** If you discover any issues with this adapter, please

docs/integrate/meltano/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ as Singer taps and targets.
3434
- [meltano-tap-cratedb]
3535
- [meltano-target-cratedb]
3636

37-
🚧 _Please note these adapters are a work in progress._ 🚧
37+
:::{todo}
38+
🚧 These adapters are a work in progress. 🚧
39+
:::
3840

3941

4042
[Examples about working with CrateDB and Meltano]: https://github.com/crate/cratedb-examples/tree/amo/meltano/framework/singer-meltano

docs/integrate/mongodb/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
:::{div}
1111
[MongoDB] is a document database designed for ease of application development and scaling.
12-
[MongoDB Atlas] is a multi-cloud database service by the same people that build MongoDB.
12+
[MongoDB Atlas] is a multi-cloud database service by the same people who build MongoDB.
1313
Atlas simplifies deploying and managing your databases while offering the versatility
1414
you need to build resilient and performant global applications on the cloud providers
1515
of your choice.

0 commit comments

Comments
 (0)