Skip to content

Docs: Restructure Metadata Ingestion topic in the Connector docs component for clarity and readability#222

Open
kiran1287 wants to merge 2 commits intoopen-metadata:mainfrom
kiran1287:restructure_metadataingestion_conn
Open

Docs: Restructure Metadata Ingestion topic in the Connector docs component for clarity and readability#222
kiran1287 wants to merge 2 commits intoopen-metadata:mainfrom
kiran1287:restructure_metadataingestion_conn

Conversation

@kiran1287
Copy link
Copy Markdown
Contributor

Summary

  • Rewrote the MetadataIngestionUi shared component to improve step clarity and consistency across all connector docs
  • Added an introductory paragraph explaining the purpose of a service connection before the steps begin
image
  • Restructured step titles and body copy to use direct, imperative language (click, select, enter) and <strong> tags instead of backtick/italic formatting
image
  • Renamed "Visit the Services Page" → "Select the Service" and split it into a numbered list for better scannability
  • Renamed "Select the Service Type" → "Select the Connector" for consistency with connector doc terminology
  • Added a bullet list and <Note> callout to the "Name and Describe your Service" step to highlight that the service name cannot be changed
image

Test plan

  • Verify the component renders correctly on at least one database connector page locally (mint dev)
  • Check that all step images still load correctly
  • Confirm no broken links introduced (mint broken-links)

@kiran1287 kiran1287 linked an issue May 6, 2026 that may be closed by this pull request
@kiran1287 kiran1287 self-assigned this May 6, 2026
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.

Update Metadata Ingestion topic in the Connectors doc

1 participant