Skip to content

Naming things: Simplify directory layout at "Integrate" section #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 14, 2025
Merged

Naming things: Simplify directory layout at "Integrate" section #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1390024
Integrate: Naming things. Simplify directory layout.
amotl Aug 13, 2025
f6223a3
Integrate: Naming things. Simplify directory layout.
amotl Aug 13, 2025
2426269
Integrate: Naming things. Adjust reference labels.
amotl Aug 14, 2025
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
6 changes: 3 additions & 3 deletions docs/ingest/cdc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ Native and specialized integration connectors for CrateDB, both managed and unma
:gutter: 2

::::{grid-item-card} Amazon DynamoDB
:link: aws-dynamodb
:link: dynamodb
:link-type: ref
Load data from DynamoDB, a fully managed NoSQL database service provided by
Amazon Web Services (AWS), which is designed for high-performance, scalable
applications and offers key-value and document data structures.
::::

::::{grid-item-card} Amazon Kinesis
:link: aws-kinesis
:link: kinesis
:link-type: ref
Load data from Amazon Kinesis Data Streams, a serverless streaming data service
that simplifies the capture, processing, and storage of data streams at any scale.
Expand All @@ -56,7 +56,7 @@ both managed and unmanaged.
:gutter: 2

::::{grid-item-card} AWS DMS
:link: aws-dms
:link: dms
:link-type: ref
Use AWS Database Migration Service (AWS DMS), a managed migration and replication
service that helps move your database and analytics workloads between different
Expand Down
62 changes: 31 additions & 31 deletions docs/ingest/etl/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,29 +27,23 @@ outlines how to use them effectively. Additionally, see support for {ref}`cdc` s


::::{grid-item-card} {material-outlined}`air;2em` Dataflow / Pipeline / Code-first
- {ref}`apache-airflow`
- {ref}`airflow`

Comment on lines +30 to 31
Copy link

@coderabbitai coderabbitai bot Aug 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Unprefixed {ref}airflow` looks good; please confirm target label exists and keep a legacy alias.

This page now references {ref}airflow. Verify that the target page defines (airflow)=and, to avoid breaking incoming links, also defines an alias for the old label (e.g.,(apache-airflow)=`) on the same page.

Run this script to check label targets and spot any leftover old-style refs:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Extract all ref labels used in this file
labels=$(rg -No '\{ref}`([a-z0-9\-]+)`' docs/ingest/etl/index.md | sed 's/.*`//; s/`$//' | sort -u)

echo "Checking label definitions for:"
printf ' - %s\n' $labels
echo

missing=0
for lbl in $labels; do
  if ! rg -n "^\($lbl\)="; then
    echo "MISSING label: ($lbl)="
    missing=1
  fi
done

echo
echo "Scanning for legacy prefixed refs still used elsewhere:"
rg -n '\{ref}`(apache-|aws-)[^`]+`' || true

exit $missing

Length of output: 514

🏁 Script executed:

#!/bin/bash
set -euo pipefail

file="docs/ingest/etl/index.md"

echo "Listing all {ref}`...` occurrences in $file (line:number -> matched):"
rg -n -oP '\{ref\}`([^`]+)`' "$file" || true
echo

echo "Extracting unique labels from those refs:"
labels=$(rg -n -oP '\{ref\}`([^`]+)`' "$file" | sed -E 's/^[0-9]+://' | sed -E 's/\{ref\}`(.*)`/\1/' | sort -u || true)
printf ' - %s\n' $labels
echo

missing=0
echo "Checking for anchor definitions for each label across the docs/ tree:"
for lbl in $labels; do
  if rg -n -F "($lbl)=" docs || true; then
    true
  else
    echo "MISSING label definition: ($lbl)="
    missing=1
  fi
done
echo

echo "Scanning repo for legacy-prefixed refs (apache- or aws-):"
rg -n '\{ref\}`(apache-|aws-)[^`]+`' docs || true
echo

exit $missing

Length of output: 5025

Add legacy anchor alias (apache-airflow) to the airflow page

Confirmed: {ref}airflow points to docs/integrate/airflow/index.md which defines (airflow)=, but a legacy alias (apache-airflow)= is not present — please add it to avoid breaking external links.

Files to check/update:

  • docs/ingest/etl/index.md — references {ref}airflow at lines 30 and 205 (no change needed here).
  • docs/integrate/airflow/index.md — add legacy alias on the same page (anchor currently at line 1).

Suggested change (add the alias next to the existing anchor):
docs/integrate/airflow/index.md
@@
(airflow)=
+(apache-airflow)=

🤖 Prompt for AI Agents 
In docs/integrate/airflow/index.md around line 1, the page defines the anchor
(airflow)= but is missing the legacy alias (apache-airflow)= which external
links rely on; add a second anchor (apache-airflow)= immediately alongside the
existing (airflow)= so both aliases are available; no changes needed to
docs/ingest/etl/index.md (it references {ref}`airflow` at lines 30 and 205).

Copy link
Member Author

@amotl amotl Aug 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coderabbitai: We decided to prune ALL legacy aliases previously kept for compatibility reasons, but fix forward instead if anything breaks. Please resolve all relevant comments.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amotl, understood! I'll note this policy change for future reviews. The "fix forward" approach makes sense for maintaining cleaner documentation structure.

✏️ Learnings added 
Learnt from: amotl
PR: crate/cratedb-guide#249
File: docs/ingest/etl/index.md:30-31
Timestamp: 2025-08-14T11:40:39.557Z
Learning: In the CrateDB Guide documentation, the project policy is to prune ALL legacy aliases (like `(apache-airflow)=`, `(aws-*)=`) and fix forward if anything breaks, rather than maintaining backward compatibility with dual anchors.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

⛔ Learnings removed 
Learnt from: amotl
PR: crate/cratedb-guide#236
File: docs/connect/ide.md:2-2
Timestamp: 2025-08-09T10:59:42.066Z
Learning: In the CrateDB Guide documentation, legacy anchor labels (like `(ide)=`) should be retained alongside newer, more specific ones (like `(connect-ide)=`) to maintain backward compatibility for external projects that might reference them, even if they appear redundant within the repository.
🧠 Learnings used 
Learnt from: amotl
PR: crate/cratedb-guide#236
File: docs/connect/ide.md:2-2
Timestamp: 2025-08-09T10:59:42.066Z
Learning: In the CrateDB Guide documentation, legacy anchor labels (like `(ide)=`) should be retained alongside newer, more specific ones (like `(connect-ide)=`) to maintain backward compatibility for external projects that might reference them, even if they appear redundant within the repository.

Apache Airflow is an open-source software platform to programmatically author,
schedule, and monitor workflows. Pipelines are defined in Python, allowing for
dynamic pipeline generation and on-demand, code-driven pipeline invocation.

- {ref}`apache-flink`

Apache Flink is a programming framework and distributed processing engine for
stateful computations over unbounded and bounded data streams, written in Java.

- {ref}`apache-nifi`

Apache NiFi is a dataflow system based on the concepts of flow-based programming.
It supports powerful and scalable directed graphs of data routing, transformation,
and system mediation logic.

- {ref}`dbt`

dbt is an SQL-first platform for transforming data in data warehouses using
Python and SQL. The data abstraction layer provided by dbt-core allows the
decoupling of the models on which reports and dashboards rely from the source data.

- {ref}`flink`

Apache Flink is a programming framework and distributed processing engine for
stateful computations over unbounded and bounded data streams, written in Java.

Comment on lines +42 to +46
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Flink: label rename is consistent; ensure alias retained to prevent broken links.

Confirm (flink)= exists on the target page and consider adding (apache-flink)= there as a compatibility alias.

If needed, I can propose a PR-wide alias list for all renamed integration labels.

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Looking for anchor labels and references for 'flink'..."

echo
echo "1) Literal anchor occurrences '(flink)=':"
rg -n -F "(flink)=" || true

echo
echo "2) Literal anchor occurrences '(apache-flink)=':"
rg -n -F "(apache-flink)=" || true

echo
echo "3) Inline refs using backticks (e.g. ref`flink`):"
rg -n "ref\`flink\`" || true
rg -n "ref\`apache-flink\`" || true

echo
echo "4) All occurrences of the word 'flink' under docs/:"
rg -n "flink" docs || true

echo
echo "5) Show docs/ingest/etl/index.md (first 200 lines) to inspect the snippet referenced in the review:"
sed -n '1,200p' docs/ingest/etl/index.md || true

Length of output: 11616

Action: add compatibility alias (apache-flink)= to the Flink page

Confirmed (flink)= is present at docs/integrate/flink/index.md:1; there is no (apache-flink)= alias in the repo — add it to avoid breaking external links.

Files to update:

  • docs/integrate/flink/index.md — add alias next to the existing anchor.
  • (no changes required) docs/ingest/etl/index.md — it already references {ref}flink (lines 42 and 212).

Suggested tiny diff:

docs/integrate/flink/index.md
@@
-(flink)=
+(flink)=
+(apache-flink)=
🤖 Prompt for AI Agents 
In docs/integrate/flink/index.md around line 1, add the compatibility alias
(apache-flink)= next to the existing (flink)= anchor so both aliases are defined
at the top of the file; no changes needed in docs/ingest/etl/index.md since it
already references {ref}`flink`. Ensure the new alias uses the same syntax and
is placed on the same anchor block as (flink)= to avoid breaking external links.

- {ref}`kestra`

Kestra is an open-source workflow automation and orchestration toolkit with a rich
Expand All @@ -63,23 +57,29 @@ outlines how to use them effectively. Additionally, see support for {ref}`cdc` s
the Singer specification. Singer is a composable open-source ETL framework and
specification, including powerful data extraction and consolidation elements.

- {ref}`nifi`

Apache NiFi is a dataflow system based on the concepts of flow-based programming.
It supports powerful and scalable directed graphs of data routing, transformation,
and system mediation logic.

Comment on lines +60 to +65
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

NiFi: label rename is consistent; ensure alias retained.

Same note: ensure (nifi)= exists and add (apache-nifi)= on the NiFi page to keep old inbound links working.

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "---- Showing docs/ingest/etl/index.md (first 200 lines) ----"
if [ -f docs/ingest/etl/index.md ]; then
  sed -n '1,200p' docs/ingest/etl/index.md || true
else
  echo "File not found: docs/ingest/etl/index.md"
fi

echo
echo "---- Searching repo for anchor labels '(^\\(nifi\\)=)' or '(^\\(apache-nifi\\)=)' ----"
rg -n --hidden --no-ignore-vcs '^\(nifi\)=|^\(apache-nifi\)=' || true

echo
echo "---- Searching for files with 'nifi' in the docs path ----"
rg -n --hidden --no-ignore-vcs 'nifi' docs || true

echo
echo "---- Listing Markdown files with 'nifi' in filename ----"
fd -e md -HI -g '*nifi*' || true

Length of output: 10013

Add (apache-nifi)= alias to the NiFi page; keep existing (nifi)=

Verified: docs/integrate/nifi/index.md contains (nifi)= at line 1 but there is no (apache-nifi)=. Please add the alias to preserve old inbound links.

Files to update / check:

  • Edit: docs/integrate/nifi/index.md — add (apache-nifi)= alongside the existing (nifi)= at the top of the file.
  • References (for awareness): docs/ingest/etl/index.md (lines ~60, 223), docs/integrate/index.md (line ~49).

Suggested top-of-file snippet:
(apache-nifi)=
(nifi)=

🤖 Prompt for AI Agents 
In docs/integrate/nifi/index.md around line 1, add the alias "(apache-nifi)="
directly above or alongside the existing "(nifi)=" so the top of the file
contains both aliases (apache-nifi)= and (nifi)=; update/save the file and then
verify inbound references in docs/ingest/etl/index.md (around lines ~60 and
~223) and docs/integrate/index.md (around line ~49) still resolve correctly.

+++
Use data pipeline programming frameworks and platforms.
::::


::::{grid-item-card} {material-outlined}`all_inclusive;2em` Low-code / No-code / Visual
- {ref}`apache-hop`

Apache Hop aims to be the future of data integration. Visual development enables
developers to be more productive than they can be through code.

- {ref}`estuary`

Estuary provides real-time data integration and modern ETL and ELT data pipelines
as a fully managed solution. Estuary Flow is a real-time, reliable change data
capture (CDC) solution.

- {ref}`hop`

Apache Hop aims to be the future of data integration. Visual development enables
developers to be more productive than they can be through code.

Comment on lines +78 to +82
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Hop: label rename is consistent; ensure alias retained.

Please verify (hop)= exists and consider (apache-hop)= as an alias on the Hop page.

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Searching for literal anchor patterns..."
rg -nF "(hop)=" || true
rg -nF "(apache-hop)=" || true

echo
echo "Searching for reStructuredText labels (e.g. '.. _hop:')..."
rg -n --hidden --no-ignore-vcs '\.\.\s*_hop\s*:' -S || true
rg -n --hidden --no-ignore-vcs '\.\.\s*_apache-hop\s*:' -S || true

echo
echo "Searching for 'Hop' mentions under docs/ to locate the Hop page(s)..."
rg -n --hidden --no-ignore-vcs -S "^\s*(#|=|-){1,6}\s*Hop" docs || true
rg -n --hidden --no-ignore-vcs -S "Hop" docs | sed -n '1,200p' || true

echo
echo "Looking for files with 'hop' in the filename (md/rst/adoc)..."
fd -HI -e md -e rst -e adoc hop || true

# Print top of the first matching file that mentions "Hop" to inspect anchors/labels
first=$(rg -n --hidden --no-ignore-vcs -l -S "Hop" docs | head -n1 || true)
echo
echo "First file with a 'Hop' mention: $first"
if [ -n "$first" ]; then
  echo "----- head of $first -----"
  sed -n '1,200p' "$first" || true
  echo "----- end head -----"
fi

Length of output: 9417

Hop label present — add (apache-hop)= alias on Hop page

Verified: (hop)= exists in docs/integrate/hop/index.md (line 1). docs/ingest/etl/index.md references Hop via {ref}hop (≈lines 78–82).

Files to update:

  • docs/integrate/hop/index.md — add alias next to the existing label.
  • docs/ingest/etl/index.md — (no change required; reference is correct)

Suggested change (small diff):

(hop)=
(apache-hop)=
🤖 Prompt for AI Agents 
In docs/integrate/hop/index.md around line 1, the existing label "(hop)=" needs
an alias so external refs like {ref}`hop` resolve consistently; add the alias
"(apache-hop)=" on the next line or beside the existing label so the file
contains both "(hop)=" and "(apache-hop)="; no changes required in
docs/ingest/etl/index.md.

- {ref}`n8n`

n8n is a workflow automation tool that helps you to connect any app with an API with
Expand All @@ -97,13 +97,13 @@ Use visual data flow and integration frameworks and platforms.


::::{grid-item-card} {material-outlined}`storage;2em` Databases
- {ref}`aws-dms`
- {ref}`dms`

AWS DMS is a managed migration and replication service that helps move your
database and analytics workloads between different kinds of databases quickly,
securely, and with minimal downtime and zero data loss.

- {ref}`aws-dynamodb`
- {ref}`dynamodb`

DynamoDB is a fully managed NoSQL database service provided by Amazon Web Services (AWS).

Expand Down Expand Up @@ -132,13 +132,13 @@ Load data from database systems.


::::{grid-item-card} {material-outlined}`fast_forward;2em` Streams
- {ref}`apache-kafka`
- {ref}`kafka`

Apache Kafka is an open-source distributed event streaming platform
for high-performance data pipelines, streaming analytics, data integration,
and mission-critical applications.

- {ref}`aws-kinesis`
- {ref}`kinesis`

Amazon Kinesis Data Streams is a serverless streaming data service that simplifies
the capture, processing, and storage of data streams at any scale, such as
Expand Down Expand Up @@ -186,7 +186,7 @@ Use serverless compute units for custom import tasks.

::::{grid-item-card} {material-outlined}`dataset;2em` Datasets

- {ref}`apache-iceberg`
- {ref}`iceberg`

Apache Iceberg is an open table format for analytic datasets.

Expand All @@ -202,25 +202,25 @@ Load data from datasets and open table formats.
:::

:::{div}
- {ref}`apache-airflow`
- {ref}`apache-flink`
- {ref}`apache-hop`
- {ref}`apache-iceberg`
- {ref}`apache-kafka`
- {ref}`apache-nifi`
- {ref}`aws-dynamodb`
- {ref}`aws-kinesis`
- {ref}`aws-dms`
- {ref}`airflow`
- {ref}`aws-lambda`
- {ref}`azure-functions`
- {ref}`dbt`
- {ref}`dms`
- {ref}`dynamodb`
- {ref}`estuary`
- {ref}`flink`
- {ref}`hop`
- {ref}`iceberg`
- {ref}`influxdb`
- {ref}`kafka`
- {ref}`kestra`
- {ref}`kinesis`
- {ref}`meltano`
- {ref}`mongodb`
- {ref}`mysql`
- {ref}`n8n`
- {ref}`nifi`
- {ref}`node-red`
- {ref}`risingwave`
- {ref}`sql-server`
Expand Down
3 changes: 1 addition & 2 deletions docs/integrate/apache-airflow/index.md → docs/integrate/airflow/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
(airflow)=
(apache-airflow)=
(astronomer)=
# Apache Airflow / Astronomer
# Airflow / Astronomer

:::{include} /_include/links.md
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/integrate/dbt/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ With dbt, anyone on your data team can safely contribute to production-grade dat
pipelines.

The idea is that data engineers make source data available to an environment where
dbt projects run, for example with [Debezium](#debezium) or with [Airflow](#apache-airflow).
dbt projects run, for example with {ref}`debezium` or with {ref}`airflow`.
Afterwards, data analysts can run their dbt projects against this data to produce models
(tables and views) that can be used with a number of [BI tools](#bi-tools).

Expand Down
5 changes: 2 additions & 3 deletions docs/integrate/aws-dms/index.md → docs/integrate/dms/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
(aws-dms)=
(cdc-dms)=
# AWS Database Migration Service
(dms)=
# DMS (AWS Database Migration Service)

:::{include} /_include/links.md
:::
Expand Down
7 changes: 3 additions & 4 deletions docs/integrate/aws-dynamodb/index.md → docs/integrate/dynamodb/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
(aws-dynamodb)=
(cdc-dynamodb)=
# Amazon DynamoDB
(dynamodb)=
# DynamoDB
Comment on lines +1 to +2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add aliases for both historical anchors

This page historically exposed (aws-dynamodb) and also appears to have been referenced as (cdc-dynamodb) in CDC-related sections. Add both as aliases to avoid breaking inbound links.

+ (aws-dynamodb)=
+ (cdc-dynamodb)=
 (dynamodb)=
 # DynamoDB
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(dynamodb)=
# DynamoDB
(aws-dynamodb)=
(cdc-dynamodb)=
(dynamodb)=
# DynamoDB
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: There might be a mistake here.
Context: (dynamodb)= # DynamoDB :::{include} /_include/links.m...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In docs/integrate/dynamodb/index.md around lines 1 to 2, the page currently
defines the DynamoDB heading but does not declare the historical anchor aliases;
add aliases for both historical anchors "(aws-dynamodb)" and "(cdc-dynamodb)" so
inbound links don't break. Update the top of the file to include explicit alias
anchors for those names (e.g., add HTML anchor tags or front-matter/alias
metadata supported by the docs site) pointing to this page, ensuring both
aws-dynamodb and cdc-dynamodb resolve here.


:::{include} /_include/links.md
:::
Expand Down Expand Up @@ -38,7 +37,7 @@ servers or infrastructure.
:::{rubric} Related
:::
- [Amazon DynamoDB Streams]
- {ref}`aws-kinesis`
- {ref}`kinesis`
- [Amazon Kinesis Data Streams]
::::

Expand Down
1 change: 0 additions & 1 deletion docs/integrate/estuary/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
(estuary)=

# Estuary

```{div} .float-right
Expand Down
3 changes: 1 addition & 2 deletions docs/integrate/apache-flink/index.md → docs/integrate/flink/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
(apache-flink)=
(flink)=
# Apache Flink
# Flink

:::{include} /_include/links.md
:::
Expand Down
4 changes: 2 additions & 2 deletions docs/integrate/apache-hop/index.md → docs/integrate/hop/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(apache-hop)=
# Apache Hop
(hop)=
# Hop
Comment on lines +1 to +2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Preserve old anchor via alias (apache-hop)

Add an alias label so existing {ref}apache-hop links keep resolving.

+ (apache-hop)=
 (hop)=
 # Hop
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(hop)=
# Hop
(apache-hop)=
(hop)=
# Hop
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: There might be a mistake here.
Context: (hop)= # Hop ```{div} .float-right [![Apache Hop...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In docs/integrate/hop/index.md around lines 1 to 2, add an alias anchor for the
old name so existing {ref}`apache-hop` links continue to resolve; place a new
anchor line "(apache-hop)=" immediately above the existing "(hop)=" line (so the
top of the file becomes "(apache-hop)=\n(hop)=\n# Hop"), ensuring both anchors
precede the heading.


```{div} .float-right
[![Apache Hop logo](https://hop.apache.org/img/hop-logo.svg){height=60px loading=lazy}][Apache Hop]
Expand Down
4 changes: 2 additions & 2 deletions docs/integrate/apache-iceberg/index.md → docs/integrate/iceberg/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(apache-iceberg)=
# Apache Iceberg
(iceberg)=
# Iceberg
Comment on lines +1 to +2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Alias the former (apache-iceberg) anchor

Add an alias to preserve existing deep links and references.

+ (apache-iceberg)=
 (iceberg)=
 # Iceberg
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(iceberg)=
# Iceberg
(apache-iceberg)=
(iceberg)=
# Iceberg
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: There might be a mistake here.
Context: (iceberg)= # Iceberg ```{div} .float-right [![Apache...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In docs/integrate/iceberg/index.md around lines 1 to 2, add an alias anchor for
the former name so existing deep links to (apache-iceberg) keep working; add a
second anchor line for the old id (apache-iceberg)= above the heading (so both
(apache-iceberg)= and (iceberg)= appear before “# Iceberg”) to preserve
references.


```{div} .float-right
[![Apache Iceberg logo](https://iceberg.apache.org/assets/images/Iceberg-logo.svg){height=60px loading=lazy}][Apache Iceberg]
Expand Down
20 changes: 10 additions & 10 deletions docs/integrate/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,7 @@ Please also visit the [Overview of CrateDB integration tutorials].
:::{toctree}
:maxdepth: 1

apache-airflow/index
apache-flink/index
apache-hop/index
apache-iceberg/index
apache-kafka/index
apache-nifi/index
apache-superset/index
aws-dynamodb/index
aws-kinesis/index
aws-dms/index
airflow/index
aws-lambda/index
azure-functions/index
cluvio/index
Expand All @@ -34,12 +25,19 @@ dbeaver/index
dbt/index
debezium/index
django/index
dms/index
dynamodb/index
estuary/index
explo/index
flink/index
gradio/index
grafana/index
hop/index
iceberg/index
influxdb/index
kafka/index
kestra/index
kinesis/index
langchain/index
llamaindex/index
marquez/index
Expand All @@ -48,6 +46,7 @@ metabase/index
mongodb/index
mysql/index
n8n/index
nifi/index
node-red/index
plotly/index
Power BI <powerbi/index>
Expand All @@ -58,6 +57,7 @@ risingwave/index
sql-server/index
streamlit/index
streamsets/index
superset/index
tableau/index
telegraf/index
:::
Expand Down
2 changes: 0 additions & 2 deletions docs/integrate/influxdb/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
(influxdb)=
(integrate-influxdb)=
(integrate-influxdb-quickstart)=
# InfluxDB

:::{include} /_include/links.md
Expand Down
4 changes: 2 additions & 2 deletions docs/integrate/apache-kafka/index.md → docs/integrate/kafka/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(apache-kafka)=
# Apache Kafka
(kafka)=
# Kafka

```{div} .float-right .text-right
[![Apache Kafka logo](https://kafka.apache.org/logos/kafka_logo--simple.png){height=60px loading=lazy}][Apache Kafka]
Expand Down
0 docs/integrate/apache-kafka/kafka-connect.md → docs/integrate/kafka/kafka-connect.md
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/integrate/aws-kinesis/index.md → docs/integrate/kinesis/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(aws-kinesis)=
# Amazon Kinesis
(kinesis)=
# Kinesis
Comment on lines +1 to +2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add backward-compatible alias for the old slug

Recommend adding (aws-kinesis) as an alias to keep old links working.

+ (aws-kinesis)=
 (kinesis)=
 # Kinesis
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(kinesis)=
# Kinesis
(aws-kinesis)=
(kinesis)=
# Kinesis
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: There might be a mistake here.
Context: (kinesis)= # Kinesis :::{include} /_include/links.md...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In docs/integrate/kinesis/index.md around lines 1 to 2, add a
backward-compatible alias anchor for the old slug by declaring the old anchor
(aws-kinesis)= alongside the existing (kinesis)= before the heading so both
anchors point to the same "Kinesis" section, ensuring old links using the
aws-kinesis slug continue to work.


:::{include} /_include/links.md
:::
Expand Down Expand Up @@ -36,7 +36,7 @@ records.

:::{rubric} Related
:::
- {ref}`aws-dynamodb`
- {ref}`dynamodb`
- [Amazon DynamoDB Streams]
::::

Expand Down
4 changes: 2 additions & 2 deletions docs/integrate/apache-nifi/index.md → docs/integrate/nifi/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(apache-nifi)=
# Apache NiFi
(nifi)=
# NiFi
Comment on lines +1 to +2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Add alias for old anchor to preserve existing inbound links

Renaming the anchor to (nifi) is good. To avoid breaking external bookmarks or internal refs that might still target (apache-nifi), add an alias anchor that points to the same page.

Apply this diff:

+ (apache-nifi)=
 (nifi)=
 # NiFi

Run this script to verify no stale refs/paths remain and that new anchors are unique:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "1) Search for old-style {ref} usages:"
rg -n '\{ref\}`(apache|aws)-[a-z0-9-]+`' -g 'docs/**' || true

echo
echo "2) Search for old integrate paths still referenced:"
rg -n 'integrate/(apache|aws)-' -g 'docs/**' || true

echo
echo "3) Search for pages still defining old anchors:"
rg -n '^\((apache|aws)-[a-z0-9-]+\)=' -g 'docs/**' || true

echo
echo "4) Ensure new anchors exist exactly once:"
for a in nifi kinesis hop dynamodb iceberg; do
  echo -n " - $a: "
  rg -n "^\($a\)=" -g 'docs/**' | wc -l | tr -d ' '
done
echo

Length of output: 1446

Add alias for old anchor to preserve existing inbound links

Renaming the anchor to (nifi) is fine — add an alias for (apache-nifi) to avoid breaking external/internal links. I ran your verification script: no refs to apache-nifi were found, but there are remaining old-style refs/anchors for aws-lambda that you may want to handle similarly.

Files to change / review:

  • docs/integrate/nifi/index.md (lines 1-2) — add alias for apache-nifi.
  • Verification findings:
    • docs/ingest/etl/index.md:169 and :206 contain {ref}aws-lambda
    • docs/integrate/aws-lambda/index.md:1 defines (aws-lambda)=

Apply this diff:

+ (apache-nifi)=
 (nifi)=
 # NiFi

Consider adding alias anchors or updating refs for other old anchors (e.g., aws-lambda) to avoid broken links.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(nifi)=
# NiFi
(apache-nifi)=
(nifi)=
# NiFi
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: There might be a mistake here.
Context: (nifi)= # NiFi ```{div} .float-right [![Apache Ni...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In docs/integrate/nifi/index.md around lines 1-2, add an alias anchor for the
old name by inserting a second anchor line for (apache-nifi) alongside the
existing (nifi) anchor before the heading so existing refs to apache-nifi
continue to work; e.g., add a line with the old anchor immediately above the "#
NiFi" heading, and optionally mirror this pattern for other renamed anchors like
aws-lambda referenced elsewhere.


```{div} .float-right
[![Apache NiFi logo](https://nifi.apache.org/images/apache-nifi-drop-logo.svg){height=60px loading=lazy}][Apache NiFi]
Expand Down
6 changes: 2 additions & 4 deletions docs/integrate/apache-superset/index.md → docs/integrate/superset/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
(apache-superset)=
(preset)=
(superset)=

# Apache Superset / Preset
(preset)=
# Superset / Preset

```{div} .float-right .text-right
[![Apache Superset logo](https://cratedb.com/hs-fs/hubfs/[email protected]?width=604&height=216&[email protected]){height=60px loading=lazy}][Apache Superset]
Expand Down