Docs: Dremio Connector Updation #122
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the Dremio database connector, which is in BETA stage. The update includes three new documentation files (overview, YAML configuration, and troubleshooting guide), updates to the connector list navigation, and image assets for the Dremio connector.
Key Changes
- Added Dremio connector card to the connectors list with BETA stage designation
- Created comprehensive documentation covering both Dremio Cloud (SaaS) and Dremio Software (self-hosted) configurations
- Added connector images and updated navigation structure in docs.json
Reviewed changes
Copilot reviewed 5 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| snippets/connectors/database/connectors-list.mdx | Added Dremio card entry with chip styling inconsistency |
| public/images/icons/dremio.webp | New connector icon image (binary file) |
| public/images/connectors/dremio.webp | New connector image (binary file) |
| docs.json | Added Dremio navigation structure with three documentation pages |
| connectors/database/dremio/yaml.mdx | YAML configuration guide with incorrect icon path |
| connectors/database/dremio/troubleshooting.mdx | Standard troubleshooting page importing reusable template |
| connectors/database/dremio/index.mdx | Main overview documentation with incorrect icon path and minor structural issue |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <div className="prod-beta-chip prod"><img src="/public/images/icons/prod-icon.svg" alt="prod" noZoom /> <div>PROD</div></div> | ||
| </Card> | ||
| <Card title="Dremio" icon="/public/images/connectors/dremio.webp" href="/connectors/database/dremio" horizontal > | ||
| <div className="prod-beta-chip prod"><img src="/public/images/icons/beta-icon.svg" alt="prod" noZoom /> <div>PROD</div></div> |
There was a problem hiding this comment.
The chip styling and text are inconsistent with the icon. The code uses beta-icon.svg but has className="prod-beta-chip prod", alt="prod", and displays "PROD" text. For consistency with other beta connectors (Cassandra, Cockroach, Epic, etc.), this should be:
className="prod-beta-chip beta"alt="beta"<div>BETA</div>
| <div className="prod-beta-chip prod"><img src="/public/images/icons/beta-icon.svg" alt="prod" noZoom /> <div>PROD</div></div> | |
| <div className="prod-beta-chip beta"><img src="/public/images/icons/beta-icon.svg" alt="beta" noZoom /> <div>BETA</div></div> |
| import SourceConfig from '/snippets/connectors/yaml/database/source-config.mdx' | ||
|
|
||
| <ConnectorDetailsHeader | ||
| icon='/public/images/icons/dremio.webp' |
There was a problem hiding this comment.
The icon path should be '/public/images/connectors/dremio.webp' instead of '/public/images/icons/dremio.webp' to be consistent with other connector documentation. All other connectors (e.g., Doris) reference icons from the '/public/images/connectors/' directory in their documentation pages.
| icon='/public/images/icons/dremio.webp' | |
| icon='/public/images/connectors/dremio.webp' |
| import Related from '/snippets/connectors/database/related.mdx' | ||
|
|
||
| <ConnectorDetailsHeader | ||
| icon='/public/images/icons/dremio.webp' |
There was a problem hiding this comment.
The icon path should be '/public/images/connectors/dremio.webp' instead of '/public/images/icons/dremio.webp' to be consistent with other connector documentation. All other connectors (e.g., Doris) reference icons from the '/public/images/connectors/' directory in their documentation pages.
| icon='/public/images/icons/dremio.webp' | |
| icon='/public/images/connectors/dremio.webp' |
| # Connection Details | ||
| <Steps> |
There was a problem hiding this comment.
The heading "# Connection Details" should be placed before the <Steps> component (after line 68), not inside it. This is inconsistent with other connector documentation patterns (e.g., connectors/database/doris/index.mdx:34-35).
| availableFeatures={["Metadata", "Query Usage", "Lineage"]} | ||
| unavailableFeatures={["Data Profiler", "Data Quality", "Column-level Lineage", "dbt", "Sample Data", "Auto-Classification", "Owners", "Tags", "Stored Procedures"]} /> | ||
| In this section, we provide guides and references to use the Dremio connector. | ||
| Configure and schedule Dremio metadata workflows from the OpenMetadata UI: |
There was a problem hiding this comment.
Inconsistent terminology: yaml.mdx uses "OpenMetadata UI" but index.mdx uses "Collate UI". For consistency within the same connector documentation and alignment with newer connectors (e.g., Redshift, Snowflake, SSAS), both files should use "OpenMetadata UI" or both should use "Collate UI".
1 participant
I worked on Dremio Connector Doc Updation.