Docs: Rewrite and restructure How to Ingest Metadata doc in the Admin Guide

[kiran1287]

Summary

• Restructured into numbered steps: Converted the flat bullet-list walkthrough into 8 clearly titled steps (Create Service Connection → Select Connector → Configure Service → Enter Connection Details → Test Connection → Save & Add Agent → Configure Agent → Schedule Agent), making it easier to follow sequentially.

• Expanded agent actions: The "Viewing Agent Run Status" section now documents all available actions (Run, Kill, Re Deploy, Edit, Delete) with clearer descriptions, including when to use Re Deploy.

• Improved image placement: Screenshots are now embedded inline within the numbered steps they illustrate, rather than stacked below unrelated bullets.
• Refined field descriptions: Service Name is now marked as required; Description as optional. Filter pattern fields have clearer, more actionable descriptions.
• Agents tab visibility: Moved from a <Tip> callout to an inline <Note> component within Step 6, surfaced at the exact point users need it.

• New sections added: "Browsing Ingested Data" and "Managing Services" break out previously mixed content into distinct, scannable headings.

- Fix colon consistency, dash style, SQL capitalization, and broken bold tags

Files Changed

• v1.11.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx
• v1.12.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx
• v1.13.x-SNAPSHOT/how-to-guides/admin-guide/how-to-ingest-metadata.mdx

Test plan

• Preview locally with mint dev and walk through the page end-to-end
• Confirm all 8 steps render correctly with images inline
• Check all internal links (Usage, Lineage, dbt, Profiler, Best Practices, Delete Service) resolve correctly for each version
• Run mint broken-links to validate no broken links introduced

[ayush-shah]

Findings:

1. v1.11.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx:68, v1.12.x/...:68, and v1.13.x-SNAPSHOT/...:68 say to click Add Metadata Agent. The current OpenMetadata UI label is Add Agent (label.add-agent in the en-us locale, rendered by AddIngestionButton.component.tsx). The same page already uses Add Agent later. Please change this label to Add Agent in all three files.

2. v1.11.x/...:113, v1.12.x/...:113, and v1.13.x-SNAPSHOT/...:113 describe Re Deploy as “Re-fetch data” and say it “ingests” additionally accessible data. In OpenMetadata, Re Deploy calls the deploy endpoint (/services/ingestionPipelines/deploy/{id}) and deploys the pipeline; Run is the separate trigger path. Suggested replacement: “Re Deploy: Redeploy the pipeline definition after configuration, schedule, or credential changes. Use Run to trigger ingestion immediately.”

3. git diff --check origin/main...HEAD reports trailing whitespace across the modified MDX files. Please remove the trailing spaces before merge.

Validation run:

• rtk mint broken-links from a PR checkout: passed, no broken links found.
• Cross-checked UI labels in OpenMetadata locale/source and agent action behavior in PipelineActionsDropdown, MetadataAgentsWidget, and IngestionPipelineResource.
• git diff --check: failed on trailing whitespace above.

Follow-up agent prompt:

You are reviewing PR #223 in open-metadata/docs-om. Do a content correctness review against the OpenMetadata product code, not only a docs grammar pass.

Scope:
- Changed files:
  - v1.11.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx
  - v1.12.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx
  - v1.13.x-SNAPSHOT/how-to-guides/admin-guide/how-to-ingest-metadata.mdx
- Validate that the three versioned files stay intentionally synchronized except for versioned links.
- Verify UI labels and workflow behavior against the OpenMetadata codebase.

Required checks:
1. Read the PR diff and compare all three versioned files for unintended drift.
2. In OpenMetadata UI source, verify labels for Add Agent, Run, Kill, Re Deploy, Edit, Delete, Service Name, Connection Details, and Use FQN For Filtering.
3. In OpenMetadata service/UI code, distinguish deploy/redeploy behavior from trigger/run behavior before approving action descriptions.
4. Run rtk mint broken-links from the PR checkout.
5. Run git diff --check origin/main...HEAD for the changed MDX files.
6. Flag only actionable issues with file path, line number, evidence from code/docs, and suggested replacement copy.

Output:
- Findings first, ordered by severity.
- Include validation commands and results.
- No praise, no generic “looks good”, no vague wording.

[Copilot]

Pull request overview

This PR rewrites and restructures the “How to Ingest Metadata” Admin Guide page across v1.11.x, v1.12.x, and v1.13.x-SNAPSHOT to provide a clearer, step-by-step walkthrough for creating services, configuring agents, scheduling ingestion, and managing post-setup tasks.

Changes:

• Reorganized the ingestion walkthrough into 8 numbered, titled steps with inline screenshots.
• Expanded/clarified agent run status actions and added separate sections for browsing ingested data and managing services.
• Refined field and filter-pattern descriptions and adjusted callout placement for better readability.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.

File	Description
v1.11.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx	Restructures the ingestion guide into numbered steps and adds post-setup sections/actions.
v1.12.x/how-to-guides/admin-guide/how-to-ingest-metadata.mdx	Mirrors the step-based rewrite and updated agent/service guidance for v1.12.x.
v1.13.x-SNAPSHOT/how-to-guides/admin-guide/how-to-ingest-metadata.mdx	Mirrors the step-based rewrite and updated agent/service guidance for v1.13.x-SNAPSHOT.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

[ayush-shah]

Reviewed latest head (1dacef8). git diff --check is clean and rtk mint broken-links passed. I found two current-head content issues below.