Docs: 2 MB issue Fix for External, Tests, Tests UI by RounakDhillon · Pull Request #203 · open-metadata/docs-om

RounakDhillon · 2026-04-28T06:20:43Z

I worked on 2 MB issue Fix for External, Tests, and Tests UI.

mintlify · 2026-04-28T06:20:47Z

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

Project	Status	Preview	Updated (UTC)
openmetadata	🟢 Ready	View Preview	Apr 28, 2026, 6:25 AM

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

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR restructures multiple documentation pages across v1.11.x, v1.12.x, and v1.13.x-SNAPSHOT to address the “2 MB issue” by splitting large sections (External ingestion examples, Column Tests UI, and Column-level Test Definitions) into dedicated pages and updating navigation links.

Changes:

Added new standalone docs pages for Column Tests (UI), Column-level test definitions (DQ as Code), and External ingestion workflow examples.
Replaced large embedded sections in overview pages with <Info> callouts linking to the new pages.
Updated docs.json navigation to group and include the newly added pages.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
v1.13.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/tests-ui/column-tests.mdx	New dedicated page for column-level UI test configuration.
v1.13.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/tests-ui.mdx	Removes embedded column tests content; adds link to new page; sidebar title update.
v1.13.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions/column-tests.mdx	New dedicated reference page for column-level SDK test definitions.
v1.13.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions.mdx	Removes embedded column-level definitions; adds link to new page.
v1.13.x-SNAPSHOT/deployment/ingestion/external/examples.mdx	New dedicated page containing external workflow code examples.
v1.13.x-SNAPSHOT/deployment/ingestion/external.mdx	Replaces embedded examples with a link to the new examples page.
v1.12.x/how-to-guides/data-quality-observability/quality/tests-ui/column-tests.mdx	New dedicated page for column-level UI test configuration.
v1.12.x/how-to-guides/data-quality-observability/quality/tests-ui.mdx	Removes embedded column tests content; adds link to new page; sidebar title update.
v1.12.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions/column-tests.mdx	New dedicated reference page for column-level SDK test definitions.
v1.12.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions.mdx	Removes embedded column-level definitions; adds link to new page.
v1.12.x/deployment/ingestion/external/examples.mdx	New dedicated page containing external workflow code examples.
v1.12.x/deployment/ingestion/external.mdx	Replaces embedded examples with a link to the new examples page.
v1.11.x/how-to-guides/data-quality-observability/quality/tests-ui/column-tests.mdx	New dedicated page for column-level UI test configuration.
v1.11.x/how-to-guides/data-quality-observability/quality/tests-ui.mdx	Removes embedded column tests content; adds link to new page; sidebar title update.
v1.11.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions/column-tests.mdx	New dedicated reference page for column-level SDK test definitions.
v1.11.x/how-to-guides/data-quality-observability/quality/data-quality-as-code/test-definitions.mdx	Removes embedded column-level definitions; adds link to new page.
v1.11.x/deployment/ingestion/external/examples.mdx	New dedicated page containing external workflow code examples.
v1.11.x/deployment/ingestion/external.mdx	Replaces embedded examples with a link to the new examples page.
docs.json	Updates sidebar/nav structure to include and group the new pages across versions.

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

Copilot · 2026-04-28T15:09:28Z

+def run():
+    workflow = MetadataWorkflow.create(CONFIG)


The code examples reference workflow classes (e.g., MetadataWorkflow) that are not imported in the snippet, and CONFIG is a YAML string but is passed directly to .create(...). Update the examples to (1) import the workflow classes used and (2) parse the YAML string into a Python dict (e.g., via yaml.safe_load) before calling .create(...), so the examples are executable as-is.

Copilot · 2026-04-28T15:09:29Z

+| Condition                    | Status |
+|------------------------------|--------|
+| All values are unique        | ✅     |
+| Any duplicate value found    | ❌     |


These Markdown tables start each row with ||, which typically renders an unintended empty first column (or breaks table formatting depending on the renderer). Replace the leading || with a single | on each row to ensure consistent table rendering.

Copilot · 2026-04-28T15:09:29Z

+### Column Values to Be Between
+Validates numeric values of a column are within a given range.


This section describes validating numeric values, but the 'When to Use' and the behavior table describe string length validation (which is also documented later as 'Column Values Lengths to Be Between'). Align the description + behavior with numeric range validation, or rename/rewrite the section so it is unambiguously about length (and avoid duplicating the later length test).

Copilot · 2026-04-28T15:09:30Z

+- Username length, field input length validation
+
+#### Behavior
+
+| Condition                                   | Status |
+|---------------------------------------------|--------|
+| Length within `[min, max]`                  | ✅     |
+| Length < min or > max                       | ❌     |


This section describes validating numeric values, but the 'When to Use' and the behavior table describe string length validation (which is also documented later as 'Column Values Lengths to Be Between'). Align the description + behavior with numeric range validation, or rename/rewrite the section so it is unambiguously about length (and avoid duplicating the later length test).

Suggested change

- Username length, field input length validation

#### Behavior

| Condition | Status |

|---------------------------------------------|--------|

| Length within `[min, max]` | ✅ |

| Length < min or > max | ❌ |

- Numeric thresholds such as age, salary, price, score, or quantity validation

#### Behavior

| Condition | Status |

|---------------------------------------------|--------|

| Value within `[min, max]` | ✅ |

| Value < min or > max | ❌ |

Copilot · 2026-04-28T15:09:30Z

+- Username length, field input length validation
+
+#### Behavior
+
+| Condition                                   | Status |
+|---------------------------------------------|--------|
+| Length within `[min, max]`                  | ✅     |
+| Length < min or > max                       | ❌     |


This section describes validating numeric values, but the 'When to Use' and the behavior table describe string length validation (which is also documented later as 'Column Values Lengths to Be Between'). Align the description + behavior with numeric range validation, or rename/rewrite the section so it is unambiguously about length (and avoid duplicating the later length test).

Suggested change

- Username length, field input length validation

#### Behavior

| Condition | Status |

|---------------------------------------------|--------|

| Length within `[min, max]` | ✅ |

| Length < min or > max | ❌ |

- Validating metrics such as age, price, quantity, or score fall within expected limits

#### Behavior

| Condition | Status |

|--------------------------------------------|--------|

| Value within `[min, max]` | ✅ |

| Value < min or > max | ❌ |

Copilot · 2026-04-28T15:09:30Z

+### ColumnValuesToBeAtExpectedLocation
+
+Validates that a specific value appears at an expected row position.


Within this PR, the UI docs describe 'Column Values To Be At Expected Location' as a latitude/longitude geospatial validation, while this SDK reference describes expected row position semantics. Please reconcile these so the meaning of "Expected Location" is consistent across UI and SDK docs (and update parameters/examples accordingly).

Copilot · 2026-04-28T15:09:31Z

+></video>
+
+### Column Values to not Match Regex
+This test allows us to specify values in a column we expect that will not match a certain regex expression. If the test find values matching the `forbiddenRegex` the test will fail. Please note that for certain databases we will fall back to SQL `LIKE` expression. The databases supporting regex pattern as of 0.13.2 are:


Grammar fix: change 'If the test find values' to 'If the test finds values'.

Suggested change

This test allows us to specify values in a column we expect that will not match a certain regex expression. If the test find values matching the `forbiddenRegex` the test will fail. Please note that for certain databases we will fall back to SQL `LIKE` expression. The databases supporting regex pattern as of 0.13.2 are:

This test allows us to specify values in a column we expect that will not match a certain regex expression. If the test finds values matching the `forbiddenRegex` the test will fail. Please note that for certain databases we will fall back to SQL `LIKE` expression. The databases supporting regex pattern as of 0.13.2 are:

ayush-shah · 2026-05-05T12:43:31Z

@copilot resolve the merge conflicts in this pull request

# Conflicts: # docs.json Co-authored-by: ayush-shah <40225091+ayush-shah@users.noreply.github.com>

Copilot · 2026-05-05T12:47:20Z

@copilot resolve the merge conflicts in this pull request

Merge conflicts resolved in commit 913112b. The 7 conflicts in docs.json were resolved by combining changes from both branches — the new pages added in main (tests-yaml-column-tests, dataframe-validation-chunking, publishing-and-best-practices, openmetadata/troubleshooting) are now included alongside the grouped navigation structure introduced in this PR.

ayush-shah · 2026-05-07T06:13:21Z

No blocking findings from this validation pass.

Validation run:

rtk mint broken-links from a fresh PR checkout: passed, no broken links found.
git diff --check scoped to the PR changed files: passed.
Checked local /public/... assets and versioned internal links referenced by changed files: all referenced local targets exist.
Reviewed the split-page navigation in docs.json; the new External Ingestion, Tests - UI Config, and Test Definitions pages are registered across v1.11.x, v1.12.x, and v1.13.x-SNAPSHOT.

Residual risk: I did not do a full visual preview walkthrough; this validation focused on mergeability, links, changed-file hygiene, and local reference integrity.

Docs: 2 MB issue Fix for External, Tests, Tests UI

9fc3e21

mintlify Bot deployed to staging April 28, 2026 06:25 View deployment

RounakDhillon linked an issue Apr 28, 2026 that may be closed by this pull request

2 MB issue Fix for External, Tests, Tests UI #204

Open

ayush-shah requested a review from Copilot April 28, 2026 14:24

Copilot started reviewing on behalf of ayush-shah April 28, 2026 15:03 View session

Copilot AI reviewed Apr 28, 2026

View reviewed changes

ayush-shah mentioned this pull request May 5, 2026

2 MB issue Fix for External, Tests, Tests UI #204

Open

ayush-shah approved these changes May 5, 2026

View reviewed changes

Copilot started work on behalf of ayush-shah May 5, 2026 12:43 View session

Merge remote-tracking branch 'origin/main' into feat/feat/2mbfixtestexui

913112b

# Conflicts: # docs.json Co-authored-by: ayush-shah <40225091+ayush-shah@users.noreply.github.com>

Copilot AI requested a review from ayush-shah May 5, 2026 12:48

Copilot finished work on behalf of ayush-shah May 5, 2026 12:48

ayush-shah closed this May 7, 2026

ayush-shah reopened this May 7, 2026

Merge branch 'main' into feat/feat/2mbfixtestexui

8ba5898

mintlify Bot deployed to staging May 7, 2026 07:16 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: 2 MB issue Fix for External, Tests, Tests UI#203

Docs: 2 MB issue Fix for External, Tests, Tests UI#203
RounakDhillon wants to merge 3 commits intomainfrom
feat/feat/2mbfixtestexui

RounakDhillon commented Apr 28, 2026

Uh oh!

mintlify Bot commented Apr 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

Copilot AI Apr 28, 2026

Uh oh!

ayush-shah commented May 5, 2026

Uh oh!

Copilot AI commented May 5, 2026

Uh oh!

ayush-shah commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		### Column Values to Be Between
		Validates numeric values of a column are within a given range.

		### ColumnValuesToBeAtExpectedLocation

		Validates that a specific value appears at an expected row position.

	This test allows us to specify values in a column we expect that will not match a certain regex expression. If the test find values matching the `forbiddenRegex` the test will fail. Please note that for certain databases we will fall back to SQL `LIKE` expression. The databases supporting regex pattern as of 0.13.2 are:
	This test allows us to specify values in a column we expect that will not match a certain regex expression. If the test finds values matching the `forbiddenRegex` the test will fail. Please note that for certain databases we will fall back to SQL `LIKE` expression. The databases supporting regex pattern as of 0.13.2 are:

Conversation

RounakDhillon commented Apr 28, 2026

Uh oh!

mintlify Bot commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

ayush-shah commented May 5, 2026

Uh oh!

Copilot AI commented May 5, 2026

Uh oh!

ayush-shah commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mintlify Bot commented Apr 28, 2026 •

edited

Loading