Skip to content

Docs: Reformat v2.0.x-SNAPSHOT connector overview pages and fix connector screenshots - #389

Open
kiran1287 wants to merge 6 commits into
mainfrom
format-2.0-connector-overview-pages
Open

Docs: Reformat v2.0.x-SNAPSHOT connector overview pages and fix connector screenshots#389
kiran1287 wants to merge 6 commits into
mainfrom
format-2.0-connector-overview-pages

Conversation

@kiran1287

@kiran1287 kiran1287 commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes all v2.0.x-SNAPSHOT connector screenshots: 256 per-connector Metadata Ingestion images (Select Service / Add New Service Name / Configure Service Connection), across all 10 categories, had been carried over from stale pre-2.0 assets instead of the current ai-2.0 versions. Every image is now sourced from and verified byte-for-byte against docs-collate's ai-2.0 reference images, mirrored under public/images/connector2.0/metadata-ingestion/.
  • Rewrites every connector overview page under v2.0.x-SNAPSHOT/connectors/ from the old generic MetadataIngestionUi/Steps component pattern into a fully-written-out single-page format matching Collate's ai-2.0 docs style: inlined six-step Metadata Ingestion content plus a shared per-category "Configure Metadata Agent" section. yaml.mdx and troubleshooting.mdx are untouched for existing connectors.
  • Adds two new connectors: Omni, and Prefect — overview, yaml, troubleshooting, docs.json entries, connector-list cards, and homepage integration grid.
  • Adds shared metadata-agent snippets per category (database, dashboard, drive, pipeline, api, ml-model, search, storage, messaging, metadata).
  • Updates ingestion guide pages: Lineage/Usage workflow docs rewritten for the current Agent-based UI, Spark Lineage documents the native OpenLineage integration (confirmed against the OpenMetadata source, POST /api/v1/openlineage/lineage), Export Lineage documents CSV/PNG/PDF export, Unity Catalog incremental extraction permissions corrected against Databricks' own docs.
  • Adds a connector search/filter bar to the v2.0.x-SNAPSHOT connectors landing page.
  • Doc-review cleanup: removed leaked Collate-only content (a "Hybrid Ingestion Runner" tip block referencing docs.getcollate.io that had leaked into 20 connector pages), Latin abbreviations, arrow characters in nav paths, missing body sentences after headings.

Test plan

  • mint broken-links passes with zero broken links across v1.12.x, v1.13.x, and v2.0.x-SNAPSHOT
  • docs.json validated as well-formed JSON
  • Every connector's ConnectorDetailsHeader verified byte-for-byte identical between its overview page and yaml.mdx
  • Every image reference verified to resolve on disk, and every v2.0.x-SNAPSHOT connector screenshot verified byte-for-byte against docs-collate's ai-2.0 source
  • Manual spot-check in mint dev recommended before merge, given the size of this change

…-page format

Rewrites every connector's overview page under v2.0.x-SNAPSHOT/connectors/
into the fully-written-out single-page style used by Collate's ai-2.0 docs,
replacing the old generic MetadataIngestionUi/Steps component pattern with
inlined six-step Metadata Ingestion content and a shared per-category
Configure Metadata Agent section. yaml.mdx and troubleshooting.mdx are left
untouched for existing connectors.

- Adds IOMETE, Google Drive, Omni, and Prefect as new connectors (overview,
  yaml, troubleshooting, docs.json entries, connector-list cards, homepage
  integration grid)
- Adds shared metadata-agent snippets per category (database, dashboard,
  drive, pipeline, api, ml-model, search, storage, messaging, metadata)
- Mirrors docs-collate's ai-2.0 image folder structure under
  public/images/connector2.0/metadata-ingestion/, sourcing every
  per-connector screenshot from the actual ai-2.0 reference images
- Updates ingestion guide pages (lineage/usage workflows, Spark lineage via
  native OpenLineage integration, export lineage, Unity Catalog incremental
  extraction permissions) to match current product behavior
- Adds a connector search/filter bar to the v2.0.x-SNAPSHOT connectors page
- Sets IOMETE to BETA stage
- Fixes doc-review checklist findings (leaked Collate-only content, Latin
  abbreviations, arrow characters in nav paths, missing body sentences after
  headings)
- Restores images that were incorrectly moved (rather than copied) out of
  public/images/connectors/, which is shared across v1.12.x, v1.13.x, and
  v2.0.x-SNAPSHOT

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 20, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
openmetadata 🟢 Ready View Preview Aug 20, 2026, 10:56 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…overview-pages

# Conflicts:
#	v2.0.x-SNAPSHOT/connectors/database/iomete.mdx
#	v2.0.x-SNAPSHOT/connectors/database/iomete/yaml.mdx
#	v2.0.x-SNAPSHOT/connectors/drive/googledrive.mdx
#	v2.0.x-SNAPSHOT/connectors/drive/googledrive/yaml.mdx
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…overview-pages

# Conflicts:
#	v2.0.x-SNAPSHOT/connectors/database/bigquery.mdx
@ayush-shah

ayush-shah commented Aug 21, 2026

Copy link
Copy Markdown
Member

[P1] Restore the deleted Google Drive screenshots

This head deletes public/images/connectors/googledrive/add-new-service.png, select-service.png, and service-connection.png, but the unchanged v1.13 page still references all three at googledrive.mdx:71-73. The page will render three broken screenshots even though the documentation-link check passes (it does not validate image existence). Please restore the assets or update the page references before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Connector pages need reformatting and image updates

2 participants