From 6cf38ec14fb26d4a69d88e0748de76331dc7caf0 Mon Sep 17 00:00:00 2001 From: Rounak Dhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Fri, 4 Apr 2025 12:05:44 +0530 Subject: [PATCH] Docs: Troubleshoot Section Addition in Pipeline Completed (#20625) --- openmetadata-docs/content/v1.6.x/collate-menu.md | 8 ++++++++ .../v1.6.x/connectors/pipeline/openlineage/index.md | 3 +-- .../connectors/pipeline/openlineage/troubleshooting.md | 6 ++++++ .../content/v1.6.x/connectors/pipeline/spline/index.md | 3 +-- .../v1.6.x/connectors/pipeline/spline/troubleshooting.md | 6 ++++++ .../content/v1.6.x/connectors/pipeline/stitch/index.md | 3 +-- .../v1.6.x/connectors/pipeline/stitch/troubleshooting.md | 7 +++++++ .../v1.6.x/connectors/pipeline/wherescape/index.md | 3 +-- .../connectors/pipeline/wherescape/troubleshooting.md | 6 ++++++ openmetadata-docs/content/v1.6.x/menu.md | 4 ++++ openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md | 8 ++++++++ .../connectors/pipeline/openlineage/index.md | 3 +-- .../connectors/pipeline/openlineage/troubleshooting.md | 6 ++++++ .../v1.7.x-SNAPSHOT/connectors/pipeline/spline/index.md | 3 +-- .../connectors/pipeline/spline/troubleshooting.md | 6 ++++++ .../v1.7.x-SNAPSHOT/connectors/pipeline/stitch/index.md | 3 +-- .../connectors/pipeline/stitch/troubleshooting.md | 7 +++++++ .../connectors/pipeline/wherescape/index.md | 3 +-- .../connectors/pipeline/wherescape/troubleshooting.md | 6 ++++++ openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md | 4 ++++ 20 files changed, 82 insertions(+), 16 deletions(-) create mode 100644 openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/troubleshooting.md create mode 100644 openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/troubleshooting.md diff --git a/openmetadata-docs/content/v1.6.x/collate-menu.md b/openmetadata-docs/content/v1.6.x/collate-menu.md index b0780d90b2e..930ec2be847 100644 --- a/openmetadata-docs/content/v1.6.x/collate-menu.md +++ b/openmetadata-docs/content/v1.6.x/collate-menu.md @@ -379,6 +379,8 @@ site_menu: url: /connectors/pipeline/wherescape - category: Connectors / Pipeline / Wherescape / Run Externally url: /connectors/pipeline/wherescape/yaml + - category: Connectors / Pipeline / Wherescape / Troubleshooting + url: /connectors/pipeline/wherescape/troubleshooting - category: Connectors / Pipeline / Dagster url: /connectors/pipeline/dagster - category: Connectors / Pipeline / Dagster / Run Externally @@ -404,6 +406,8 @@ site_menu: url: /connectors/pipeline/stitch - category: Connectors / Pipeline / Stitch / Run Externally url: /connectors/pipeline/stitch/yaml + - category: Connectors / Pipeline / Stitch / Troubleshooting + url: /connectors/pipeline/stitch/troubleshooting - category: Connectors / Pipeline / Databricks Pipeline url: /connectors/pipeline/databricks-pipeline - category: Connectors / Pipeline / Databricks Pipeline / Run Externally @@ -428,10 +432,14 @@ site_menu: url: /connectors/pipeline/nifi/troubleshooting - category: Connectors / Pipeline / Openlineage url: /connectors/pipeline/openlineage + - category: Connectors / Pipeline / Troubleshooting + url: /connectors/pipeline/openlineage/troubleshooting - category: Connectors / Pipeline / Spline url: /connectors/pipeline/spline - category: Connectors / Pipeline / Spline / Run Externally url: /connectors/pipeline/spline/yaml + - category: Connectors / Pipeline / Spline / troubleshooting + url: /connectors/pipeline/spline/troubleshooting - category: Connectors / Pipeline / Flink url: /connectors/pipeline/flink - category: Connectors / Pipeline / Flink / Run Externally diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/index.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/index.md index 88f115332c3..0670c41da7d 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/index.md +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/index.md @@ -17,6 +17,7 @@ Configure and schedule OpenLineage metadata workflows from the OpenMetadata UI: - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) +- [Troubleshooting](/connectors/pipeline/openlineage/troubleshooting) {% partial file="/v1.6/connectors/ingestion-modes-tiles.md" /%} @@ -275,5 +276,3 @@ openlineage_service_request = CreatePipelineServiceRequest( metadata.create_or_update(openlineage_service_request) ``` - -{% partial file="/v1.6/connectors/troubleshooting.md" /%} \ No newline at end of file diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/troubleshooting.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/troubleshooting.md new file mode 100644 index 00000000000..c8cb6499ff0 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/openlineage/troubleshooting.md @@ -0,0 +1,6 @@ +--- +title: OpenLineage Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/openlineage/troubleshooting +--- + +{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/index.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/index.md index c4f1720b0a6..9106acb6c30 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/index.md +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/index.md @@ -18,6 +18,7 @@ Configure and schedule Spline metadata and profiler workflows from the OpenMetad - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) +- [Troubleshooting](/connectors/pipeline/spline/troubleshooting) {% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/spline/yaml"} /%} @@ -63,5 +64,3 @@ You can refer [this](https://github.com/AbsaOSS/spline-getting-started/tree/main {% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%} {% /stepsContainer %} - -{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/troubleshooting.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/troubleshooting.md new file mode 100644 index 00000000000..10de8bfbde3 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/spline/troubleshooting.md @@ -0,0 +1,6 @@ +--- +title: Spline Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/spline/troubleshooting +--- + +{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/index.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/index.md index be368f2f429..a22516f3b3a 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/index.md +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/index.md @@ -19,6 +19,7 @@ Configure and schedule Stitch metadata and profiler workflows from the OpenMetad - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) +- [Troubleshooting](/connectors/pipeline/stitch/troubleshooting) {% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/stitch/yaml"} /%} @@ -61,5 +62,3 @@ To extract metadata from Stitch, User first need to crate API crednetials: {% /stepsContainer %} By successfully completing these steps, the lineage information for the service will be displayed. - -{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/troubleshooting.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/troubleshooting.md new file mode 100644 index 00000000000..070f4b87925 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/stitch/troubleshooting.md @@ -0,0 +1,7 @@ +--- +title: Stitch Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/stitch/troubleshooting +collate: true +--- + +{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/index.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/index.md index 39782b955a4..4c3f0d7b08b 100644 --- a/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/index.md +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/index.md @@ -18,6 +18,7 @@ Configure and schedule Wherescape metadata workflow from the OpenMetadata UI: - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) - [Connection Details](#connection-details) +- [Troubleshooting](/connectors/pipeline/wherescape/troubleshooting) {% partial file="/v1.6/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/wherescape/yaml"} /%} @@ -70,5 +71,3 @@ In terms of `connection` we support the following selections: {% partial file="/v1.6/connectors/ingestion-schedule-and-deploy.md" /%} {% /stepsContainer %} - -{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/troubleshooting.md b/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/troubleshooting.md new file mode 100644 index 00000000000..3cdaf7b67e4 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/connectors/pipeline/wherescape/troubleshooting.md @@ -0,0 +1,6 @@ +--- +title: Wherescape Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/wherescape/troubleshooting +--- + +{% partial file="/v1.6/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/menu.md b/openmetadata-docs/content/v1.6.x/menu.md index 7c2745abe0e..eb7ed67f98a 100644 --- a/openmetadata-docs/content/v1.6.x/menu.md +++ b/openmetadata-docs/content/v1.6.x/menu.md @@ -614,10 +614,14 @@ site_menu: url: /connectors/pipeline/nifi/troubleshooting - category: Connectors / Pipeline / Openlineage url: /connectors/pipeline/openlineage + - category: Connectors / Pipeline / Troubleshooting + url: /connectors/pipeline/openlineage/troubleshooting - category: Connectors / Pipeline / Spline url: /connectors/pipeline/spline - category: Connectors / Pipeline / Spline / Run Externally url: /connectors/pipeline/spline/yaml + - category: Connectors / Pipeline / Spline / troubleshooting + url: /connectors/pipeline/spline/troubleshooting - category: Connectors / Pipeline / Flink url: /connectors/pipeline/flink - category: Connectors / Pipeline / Flink / Run Externally diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md index 0b2af8c7219..8a13016c33f 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md @@ -387,6 +387,8 @@ site_menu: url: /connectors/pipeline/wherescape - category: Connectors / Pipeline / Wherescape / Run Externally url: /connectors/pipeline/wherescape/yaml + - category: Connectors / Pipeline / Wherescape / Troubleshooting + url: /connectors/pipeline/wherescape/troubleshooting - category: Connectors / Pipeline / Dagster url: /connectors/pipeline/dagster - category: Connectors / Pipeline / Dagster / Run Externally @@ -412,6 +414,8 @@ site_menu: url: /connectors/pipeline/stitch - category: Connectors / Pipeline / Stitch / Run Externally url: /connectors/pipeline/stitch/yaml + - category: Connectors / Pipeline / Stitch / Troubleshooting + url: /connectors/pipeline/stitch/troubleshooting - category: Connectors / Pipeline / Databricks Pipeline url: /connectors/pipeline/databricks-pipeline - category: Connectors / Pipeline / Databricks Pipeline / Run Externally @@ -436,10 +440,14 @@ site_menu: url: /connectors/pipeline/nifi/troubleshooting - category: Connectors / Pipeline / Openlineage url: /connectors/pipeline/openlineage + - category: Connectors / Pipeline / Troubleshooting + url: /connectors/pipeline/openlineage/troubleshooting - category: Connectors / Pipeline / Spline url: /connectors/pipeline/spline - category: Connectors / Pipeline / Spline / Run Externally url: /connectors/pipeline/spline/yaml + - category: Connectors / Pipeline / Spline / troubleshooting + url: /connectors/pipeline/spline/troubleshooting - category: Connectors / Pipeline / Flink url: /connectors/pipeline/flink - category: Connectors / Pipeline / Flink / Run Externally diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/index.md index 09d4f16f3de..9561522c2cd 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/index.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/index.md @@ -17,6 +17,7 @@ Configure and schedule OpenLineage metadata workflows from the OpenMetadata UI: - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) +- [Troubleshooting](/connectors/pipeline/openlineage/troubleshooting) {% partial file="/v1.7/connectors/ingestion-modes-tiles.md" /%} @@ -275,5 +276,3 @@ openlineage_service_request = CreatePipelineServiceRequest( metadata.create_or_update(openlineage_service_request) ``` - -{% partial file="/v1.7/connectors/troubleshooting.md" /%} \ No newline at end of file diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/troubleshooting.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/troubleshooting.md new file mode 100644 index 00000000000..f7b7a436e0e --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/openlineage/troubleshooting.md @@ -0,0 +1,6 @@ +--- +title: OpenLineage Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/openlineage/troubleshooting +--- + +{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/index.md index 70c9e98da3c..a2f570a8f58 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/index.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/index.md @@ -18,6 +18,7 @@ Configure and schedule Spline metadata and profiler workflows from the OpenMetad - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) +- [Troubleshooting](/connectors/pipeline/spline/troubleshooting) {% partial file="/v1.7/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/spline/yaml"} /%} @@ -63,5 +64,3 @@ You can refer [this](https://github.com/AbsaOSS/spline-getting-started/tree/main {% partial file="/v1.7/connectors/ingestion-schedule-and-deploy.md" /%} {% /stepsContainer %} - -{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/troubleshooting.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/troubleshooting.md new file mode 100644 index 00000000000..29b9984780e --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/spline/troubleshooting.md @@ -0,0 +1,6 @@ +--- +title: Spline Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/spline/troubleshooting +--- + +{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/index.md index 3959407d4b7..3910a75e47f 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/index.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/index.md @@ -19,6 +19,7 @@ Configure and schedule Stitch metadata and profiler workflows from the OpenMetad - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) +- [Troubleshooting](/connectors/pipeline/stitch/troubleshooting) {% partial file="/v1.7/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/stitch/yaml"} /%} @@ -61,5 +62,3 @@ To extract metadata from Stitch, User first need to crate API crednetials: {% /stepsContainer %} By successfully completing these steps, the lineage information for the service will be displayed. - -{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/troubleshooting.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/troubleshooting.md new file mode 100644 index 00000000000..f23f466fffa --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/stitch/troubleshooting.md @@ -0,0 +1,7 @@ +--- +title: Stitch Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/stitch/troubleshooting +collate: true +--- + +{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/index.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/index.md index 8b04a04d5af..2aa007635a2 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/index.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/index.md @@ -18,6 +18,7 @@ Configure and schedule Wherescape metadata workflow from the OpenMetadata UI: - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) - [Connection Details](#connection-details) +- [Troubleshooting](/connectors/pipeline/wherescape/troubleshooting) {% partial file="/v1.7/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/wherescape/yaml"} /%} @@ -64,5 +65,3 @@ In terms of `connection` we support the following selections: {% partial file="/v1.7/connectors/ingestion-schedule-and-deploy.md" /%} {% /stepsContainer %} - -{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/troubleshooting.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/troubleshooting.md new file mode 100644 index 00000000000..f2f4ca45daf --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/wherescape/troubleshooting.md @@ -0,0 +1,6 @@ +--- +title: Wherescape Connector Troubleshooting Guide | OpenMetadata Support +slug: /connectors/pipeline/wherescape/troubleshooting +--- + +{% partial file="/v1.7/connectors/troubleshooting.md" /%} diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md index 4ad54e18803..b160433ef4e 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md @@ -622,10 +622,14 @@ site_menu: url: /connectors/pipeline/nifi/troubleshooting - category: Connectors / Pipeline / Openlineage url: /connectors/pipeline/openlineage + - category: Connectors / Pipeline / Troubleshooting + url: /connectors/pipeline/openlineage/troubleshooting - category: Connectors / Pipeline / Spline url: /connectors/pipeline/spline - category: Connectors / Pipeline / Spline / Run Externally url: /connectors/pipeline/spline/yaml + - category: Connectors / Pipeline / Spline / troubleshooting + url: /connectors/pipeline/spline/troubleshooting - category: Connectors / Pipeline / Flink url: /connectors/pipeline/flink - category: Connectors / Pipeline / Flink / Run Externally