Conversation
There was a problem hiding this comment.
Pull request overview
Updates the database connector documentation (Delta Lake through Epic) to shift from the removed “Run Externally (YAML)” pages toward “Hybrid Runner” pages, while keeping old URLs working via redirects and improving troubleshooting discoverability.
Changes:
- Replaces sidebar entries from
*/yamlto*/hybrid-runnerfor Delta Lake, Domo Database, Doris, Dremio, Druid, DynamoDB, and Epic. - Adds redirect rules from legacy
*/yamlroutes to the new*/hybrid-runnerroutes. - Adds “Troubleshooting” links/sections to the affected connector overview pages and introduces new Hybrid Runner pages.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs.json | Updates sidebar pages to point to hybrid-runner and adds redirects from legacy yaml routes. |
| connectors/database/deltalake/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/deltalake/index.mdx | Adds a Troubleshooting section/card. |
| connectors/database/deltalake/hybrid-runner.mdx | Adds new Hybrid Runner page for Delta Lake. |
| connectors/database/domo-database/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/domo-database/index.mdx | Adds a Troubleshooting section/card. |
| connectors/database/domo-database/hybrid-runner.mdx | Adds new Hybrid Runner page for Domo Database. |
| connectors/database/doris/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/doris/index.mdx | Adds a Troubleshooting section/card and adjusts SSL section formatting. |
| connectors/database/doris/hybrid-runner.mdx | Adds new Hybrid Runner page for Doris. |
| connectors/database/dremio/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/dremio/index.mdx | Removes the “Run Externally” link and adds a Troubleshooting section/card. |
| connectors/database/dremio/hybrid-runner.mdx | Adds new Hybrid Runner page for Dremio. |
| connectors/database/druid/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/druid/index.mdx | Adds a Troubleshooting section/card. |
| connectors/database/druid/hybrid-runner.mdx | Adds new Hybrid Runner page for Druid. |
| connectors/database/dynamodb/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/dynamodb/index.mdx | Adds a Troubleshooting section/card. |
| connectors/database/dynamodb/hybrid-runner.mdx | Adds new Hybrid Runner page for DynamoDB. |
| connectors/database/epic/yaml.mdx | Removes the legacy YAML (“Run Externally”) page. |
| connectors/database/epic/index.mdx | Adds Troubleshooting link/section and removes the Hybrid Runner secrets tip from the overview. |
| connectors/database/epic/hybrid-runner.mdx | Adds new Hybrid Runner page for Epic (including the secrets tip). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| availableFeatures={["Metadata", "dbt"]} | ||
| unavailableFeatures={["Query Usage", "Data Profiler", "Data Quality", "Lineage", "Column-level Lineage", "Owners", "Tags", "Stored Procedures", "Sample Data", "Auto-Classification"]} /> | ||
| In this section, we provide guides and references to use the Delta Lake connector. | ||
| Configure and schedule Delta Lake metadata and profiler workflows from the OpenMetadata UI: |
There was a problem hiding this comment.
The connector header marks Data Profiler as unavailable, but this intro line says users can schedule “metadata and profiler workflows”. This is contradictory; consider updating the wording to just “metadata workflows” (or update available/unavailable features if profiler is actually supported).
| Configure and schedule Delta Lake metadata and profiler workflows from the OpenMetadata UI: | |
| Configure and schedule Delta Lake metadata workflows from the OpenMetadata UI: |
| Delta Lake requires to run with Python 3.9, 3.10 or 3.11. We do not yet support the Delta connector | ||
| for Python 3.11 |
There was a problem hiding this comment.
The Python version requirement is internally inconsistent: it says Python 3.11 is supported and then immediately says 3.11 is not supported. Please clarify the supported Python versions (e.g., remove 3.11 from the supported list or update the follow-up sentence).
| Delta Lake requires to run with Python 3.9, 3.10 or 3.11. We do not yet support the Delta connector | |
| for Python 3.11 | |
| Delta Lake requires Python 3.9 or 3.10. We do not yet support the Delta connector on Python 3.11. |
| Configure and schedule DomoDatabase metadata and profiler workflows from the OpenMetadata UI: | ||
| - [Requirements](#requirements) | ||
| - [Metadata Ingestion](#metadata-ingestion) | ||
| - [Data Profiler](/how-to-guides/data-quality-observability/profiler/profiler-workflow) | ||
| - [dbt Integration](/connectors/database/dbt) | ||
| - [Troubleshooting](/connectors/database/domo-database/troubleshoot) | ||
| ## Requirements | ||
| For metadata ingestion, make sure to add at least `data` scopes to the clientId provided. | ||
| For questions related to scopes, click [here](https://developer.domo.com/portal/1845fc11bbe5d-api-authentication). |
There was a problem hiding this comment.
The nav list includes Data Profiler and dbt Integration, but the connector header explicitly lists both as unavailable features. Please remove these links / “profiler workflows” wording, or update the available/unavailable features to match the intended capabilities.
| Configure and schedule DomoDatabase metadata and profiler workflows from the OpenMetadata UI: | |
| - [Requirements](#requirements) | |
| - [Metadata Ingestion](#metadata-ingestion) | |
| - [Data Profiler](/how-to-guides/data-quality-observability/profiler/profiler-workflow) | |
| - [dbt Integration](/connectors/database/dbt) | |
| - [Troubleshooting](/connectors/database/domo-database/troubleshoot) | |
| ## Requirements | |
| For metadata ingestion, make sure to add at least `data` scopes to the clientId provided. | |
| For questions related to scopes, click [here](https://developer.domo.com/portal/1845fc11bbe5d-api-authentication). | |
| Configure and schedule DomoDatabase metadata workflows from the OpenMetadata UI: | |
| - [Requirements](#requirements) | |
| - [Metadata Ingestion](#metadata-ingestion) | |
| - [Troubleshooting](/connectors/database/domo-database/troubleshoot) | |
| ## Requirements | |
| For metadata ingestion, make sure to add at least `data` scopes to the clientId provided. | |
| For questions related to scopes, click [here](https://developer.domo.com/portal/1845fc11bbe5d-api-authentication). | |
| For metadata ingestion, make sure to add at least `data` scopes to the clientId provided. | |
| For questions related to scopes, click [here](https://developer.domo.com/portal/1845fc11bbe5d-api-authentication). |
| - **databaseSchema**: databaseSchema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single databaseSchema. When left blank, OpenMetadata Ingestion attempts to scan all the databaseSchema. | ||
| - **caCertificate**: Provide the path to ssl ca file. | ||
| - **sslCertificate**: Provide the path to ssl client certificate file (ssl_cert). | ||
| - **sslKey**: Provide the path to ssl client certificate file (ssl_key). |
There was a problem hiding this comment.
sslKey refers to the client private key, not a certificate. The description currently says “ssl client certificate file (ssl_key)”; please update it to indicate this is the private key file/path.
| - **sslKey**: Provide the path to ssl client certificate file (ssl_key). | |
| - **sslKey**: Provide the path to the ssl client private key file (ssl_key). |
Resolved conflict by merging connector redirects in docs.json - kept both sets of redirects for deltalake, domo-database, doris, dremio, druid, dynamodb, epic and redshift, s3-datalake, salesforce, sap-erp, sap-hana, sas, servicenow. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Resolved modify/delete conflicts by confirming deletion of yaml.mdx files for deltalake, domo-database, doris, dremio, druid, dynamodb, and epic connectors. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
I worked on SAAS/BYOC & Hybrid Runner Section updation from Deltalake to Epic.