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
amotl 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 2 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
2 changes: 1 addition & 1 deletion docs/integrate/apache-airflow/index.md → docs/integrate/airflow/index.md
View file
Open in desktop
Copy link
Member Author

@amotl amotl Aug 13, 2025

Choose a reason for hiding this comment

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

Sure that needs some rewrite rules.

rewrite ^/docs/guide/integrate/apache-(.*)/(.*)$                     /docs/guide/integrate/$1/$2           redirect;
rewrite ^/docs/guide/integrate/aws-(.*)/(.*)$                        /docs/guide/integrate/$1/$2           redirect;

Copy link
Member Author

@amotl amotl Aug 13, 2025

Choose a reason for hiding this comment

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

Added to the set of redirects for the current iteration.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(airflow)=
(apache-airflow)=
(astronomer)=
# Apache Airflow / Astronomer
# Airflow / Astronomer

:::{include} /_include/links.md
:::
Expand Down
2 changes: 1 addition & 1 deletion 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,6 @@
(aws-dms)=
(cdc-dms)=
# AWS Database Migration Service
# DMS (AWS Database Migration Service)

:::{include} /_include/links.md
:::
Expand Down
2 changes: 1 addition & 1 deletion 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,6 @@
(aws-dynamodb)=
(cdc-dynamodb)=
# Amazon DynamoDB
# DynamoDB

:::{include} /_include/links.md
:::
Expand Down
2 changes: 1 addition & 1 deletion 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,6 @@
(apache-flink)=
(flink)=
# Apache Flink
# Flink

:::{include} /_include/links.md
:::
Expand Down
2 changes: 1 addition & 1 deletion 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

```{div} .float-right
[![Apache Hop logo](https://hop.apache.org/img/hop-logo.svg){height=60px loading=lazy}][Apache Hop]
Expand Down
2 changes: 1 addition & 1 deletion 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

```{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: 1 addition & 1 deletion 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)=
Copy link
Contributor

@bmunkholm bmunkholm Aug 14, 2025

Choose a reason for hiding this comment

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

How about these references (not just here but all the similar ones) ?

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.

Reference labels go orthogonal to any other structure (physical/folder/files/toc), but haven't been touched here yet. It could be a good idea to also use the canonical labels going forward, thanks!

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.

2426269 adjusts the reference labels accordingly. Let's do the proper spring cleaning right away instead of deferring it to a future iteration.

# Apache 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.
2 changes: 1 addition & 1 deletion 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

:::{include} /_include/links.md
:::
Expand Down
2 changes: 1 addition & 1 deletion 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

```{div} .float-right
[![Apache NiFi logo](https://nifi.apache.org/images/apache-nifi-drop-logo.svg){height=60px loading=lazy}][Apache NiFi]
Expand Down
2 changes: 1 addition & 1 deletion 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
Expand Up @@ -2,7 +2,7 @@
(preset)=
(superset)=

# Apache Superset / 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
Loading