Skip to content

fix(ui): drop redundant outer frame card on Domain & Data Product docs#30450

Open
siddhant1 wants to merge 5 commits into
mainfrom
remove-description-outer-card
Open

fix(ui): drop redundant outer frame card on Domain & Data Product docs#30450
siddhant1 wants to merge 5 commits into
mainfrom
remove-description-outer-card

Conversation

@siddhant1

@siddhant1 siddhant1 commented Jul 24, 2026

Copy link
Copy Markdown
Member

ℹ️ Continuation of #30338 — re-opened from a branch on open-metadata/OpenMetadata (previously on a fork) so CI runs with full repository access. See #30338 for the earlier review discussion.

What

On the Documentation tab of Domain and Data Product detail pages, the Description now renders as a single, clean card — flush‑aligned with the tabs on the left and the right‑hand panel on top.

Previously the Description was wrapped in two nested cards: the standard left‑panel frame (its own background + border + shadow, plus a 16px inner padding) and the Description's own wrapInCard box. Because both pages place the Description as the sole child of the left panel, the frame just duplicated the card — a double border with an uneven gap at the bottom, and the inner card sat inset ~16px from everything around it.

How

  • Added an opt‑in variant prop to GenericTab ('default' | 'flat', defaults to 'default').
  • The flat variant drops the left‑panel frame (background: transparent; border: none; box-shadow: none) and zeroes the frame's inner padding, so the lone Description card lines up flush with the tabs (left) and the right panel (top) instead of being inset by the frame gap.
  • Domain and Data Product Documentation tabs opt in via <GenericTab … variant="flat" />.
  • Tidied the inner Description card's corner radius (rounded-[10px]rounded-xl) now that it's the only card and its corners are more visible.

Every other entity type (Tables, Dashboards, etc.) is untouched — their left panel legitimately holds multiple sections (Description and Schema), so variant defaults to 'default' and they keep the frame. The flat-left-panel override is scoped to that class, which is only ever added on these two pages, so nothing else can regress.

Before / After

Domain

Before After

Data Product

Before After

Testing

  • UI checkstyle (organize‑imports → eslint → prettier) runs clean on all changed files.
  • Verified live on a local dev server against both the Domain and Data Product Documentation tabs (screenshots above). Computed layout confirms the result:
    • The outer left‑panel frame goes to border: 0 / background: transparent / box-shadow: none.
    • The Description card's left edge (269px) now matches the tabs, and its top (400px) matches the right panel — vs. being offset by one @padding-md (16px) on both axes before.
  • The flat-left-panel class is applied only when variant="flat", so no other entity type can regress.

🤖 Generated with Claude Code

Greptile Summary

Updates the Domain and Data Product Documentation tabs to use an opt-in flat GenericTab layout that removes the redundant outer frame and adjusts the Description card radius.

Confidence Score: 5/5

The PR appears safe to merge because no new blocking failure eligible for this follow-up review was identified.

No blocking failure remains beyond the issue already communicated in the previous inline thread.

Important Files Changed

Filename Overview
openmetadata-ui/src/main/resources/ui/src/components/Customization/GenericTab/GenericTab.tsx Adds the optional flat variant and applies its scoped layout class.
openmetadata-ui/src/main/resources/ui/src/components/Customization/GenericTab/generic-tab.less Removes the left-panel frame styling and padding when flat mode is selected.
openmetadata-ui/src/main/resources/ui/src/components/common/EntityDescription/Description.tsx Replaces the custom card radius with the standard extra-large radius utility.
openmetadata-ui/src/main/resources/ui/src/utils/DataProductUtils.tsx Enables the flat GenericTab variant for Data Product documentation.
openmetadata-ui/src/main/resources/ui/src/utils/DomainUtils.tsx Enables the flat GenericTab variant for Domain documentation.

Reviews (3): Last reviewed commit: "Merge branch 'main' into remove-descript..." | Re-trigger Greptile

siddhant1 and others added 3 commits July 23, 2026 18:03
The Documentation tab on Domain and Data Product detail pages renders the
Description as the sole left-panel widget, so the standard left-panel frame
card wrapped the Description's own card — a redundant double card with an
uneven gap at the bottom.

Add an opt-in `flat` variant to GenericTab that drops the left-panel frame
(background / border / shadow) and its inner padding, leaving a single
Description card flush-aligned with the tabs (left) and the right panel
(top). Every other entity type is unchanged because the variant defaults to
`default`, so pages whose left panel legitimately holds multiple sections
keep their frame.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 24, 2026 09:05
@siddhant1
siddhant1 requested a review from a team as a code owner July 24, 2026 09:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

Copy link
Copy Markdown
Contributor

❌ PR checklist incomplete

This PR cannot be merged until the following are addressed on its linked issue:

  • No GitHub issue is linked. Link an issue in the Development section of the PR (or add Fixes #12345 to the description). For a same-org cross-repo issue, add Fixes open-metadata/<repo>#123 to the description.

The fields live on the linked issue in the Shipping project (open the issue → right sidebar → Projects). After you set them, re-run this check (or push a commit) — issue/project changes do not re-trigger it automatically.

Maintainers can bypass this check by adding the skip-pr-checks label.

@github-actions

Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@gitar-bot

gitar-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Removes the redundant outer frame card on Domain and Data Product documentation tabs by adding an opt-in 'flat' variant to GenericTab. No issues found.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@siddhant1 siddhant1 added safe to test Add this label to run secure Github workflows on PRs skip-pr-checks Bypass PR metadata validation check labels Jul 24, 2026
Comment thread openmetadata-ui/src/main/resources/ui/src/utils/DomainUtils.tsx
@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Jest test Coverage

UI tests summary

Lines Statements Branches Functions
Coverage: 65%
65.67% (76762/116888) 49.5% (46020/92952) 50.76% (13890/27362)

@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

✅ Playwright Results — workflow succeeded

Validated commit 411678f9ce9e93bfa5e45fed07370c92c91d2186 in Playwright run 30091058959, attempt 1.

✅ 536 passed · ❌ 0 failed · 🟡 1 flaky · ⏭️ 5 skipped · 🧰 0 lifecycle flaky

Performance

Blocking targets: ✅ met · Optimization targets: 🟡 in progress

Shard-job maxima below are not the full workflow wall time; the linked run includes build, fixture, planning, and reporting.

🕒 Full workflow signal wall (to summary) 48m 36s

⏱️ Max setup 3m 6s · max shard execution 14m 30s · max shard-job elapsed before upload 17m 34s · reporting 5s

🌐 202.74 requests/attempt · 2.86 app boots/UI scenario · 20.57% common-shard skew

Optimization targets still in progress:

  • Common shard skew was 20.57% (convergence target: at most 15%).
  • Browser traffic was 202.74 requests per attempt (convergence target: fewer than 200).
  • Application boot ratio was 2.86 per UI scenario (1601 boots / 559 scenarios; convergence target: at most 1).
Shard Passed Failed Flaky Skipped Lifecycle failed Lifecycle flaky
✅ Shard chromium-01 85 0 0 0 0 0
🟡 Shard chromium-02 99 0 1 0 0 0
✅ Shard chromium-03 110 0 0 0 0 0
✅ Shard chromium-04 104 0 0 3 0 0
✅ Shard data-asset-rules-01 61 0 0 0 0 0
✅ Shard domain-isolation-01 14 0 0 0 0 0
✅ Shard global-state-01 23 0 0 0 0 0
✅ Shard ingestion-01 1 0 0 0 0 0
✅ Shard reindex-01 2 0 0 0 0 0
✅ Shard search-01 10 0 0 0 0 0
✅ Shard search-rbac-01 27 0 0 2 0 0
🟡 1 flaky test(s) (passed on retry)
  • Pages/Entity.spec.tsDelete Table (shard chromium-02, 1 retry)

📦 Download artifacts

How to debug locally
# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

Copilot AI review requested due to automatic review settings July 24, 2026 10:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Copilot AI review requested due to automatic review settings July 24, 2026 11:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@gitar-bot

gitar-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Removes the redundant outer frame card on Domain and Data Product documentation tabs by adding an opt-in 'flat' variant to GenericTab. No issues found.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@sonarqubecloud

Copy link
Copy Markdown

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

Labels

safe to test Add this label to run secure Github workflows on PRs skip-pr-checks Bypass PR metadata validation check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants