Skip to content

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

Closed
siddhant1 wants to merge 3 commits into
open-metadata:mainfrom
siddhant1:remove-description-outer-card
Closed

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

Conversation

@siddhant1

@siddhant1 siddhant1 commented Jul 22, 2026

Copy link
Copy Markdown
Member

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

This PR simplifies the Documentation layout for Domain and Data Product pages. The main changes are:

  • Adds a flat variant to GenericTab.
  • Removes the redundant outer left-panel frame on both pages.
  • Keeps the Description widget as the visible card.
  • Updates the Description card radius to rounded-xl.

Confidence Score: 5/5

No additional blocking issue qualifies for this follow-up review.

  • No new incomplete fix or distinct production failure was identified in the available changes.

Important Files Changed

Filename Overview
openmetadata-ui/src/main/resources/ui/src/components/Customization/GenericTab/GenericTab.tsx Adds the optional flat layout variant and its scoped class.
openmetadata-ui/src/main/resources/ui/src/components/Customization/GenericTab/generic-tab.less Removes the left-panel frame and padding when the flat variant is active.
openmetadata-ui/src/main/resources/ui/src/components/common/EntityDescription/Description.tsx Updates the Description card to use the standard extra-large radius utility.
openmetadata-ui/src/main/resources/ui/src/utils/DomainUtils.tsx Enables the flat Documentation layout for Domain pages.
openmetadata-ui/src/main/resources/ui/src/utils/DataProductUtils.tsx Enables the flat Documentation layout for Data Product pages.

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

Context used (3)

  • Context used - openmetadata-ui-core-components/CLAUDE.md (source)
  • Context used - CLAUDE.md (source)
  • Context used - AGENTS.md (source)

Copilot AI review requested due to automatic review settings July 22, 2026 08:52
@siddhant1
siddhant1 requested a review from a team as a code owner July 22, 2026 08: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.

@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!

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

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Jest test Coverage

UI tests summary

Lines Statements Branches Functions
Coverage: 65%
65.54% (76463/116658) 49.41% (45748/92587) 50.27% (13834/27519)

anuj-kumary
anuj-kumary previously approved these changes Jul 22, 2026
@siddhant1
siddhant1 enabled auto-merge July 22, 2026 09:42
Copilot AI review requested due to automatic review settings July 23, 2026 04:29

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

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

🔴 Playwright Results — 14 pipeline/setup failure(s)

✅ 0 passed · ❌ 0 failed · 🟡 0 flaky · ⏭️ 0 skipped

Pipeline and setup failures

  • Shard 1 did not upload a usable Playwright results artifact.
  • Shard 2 did not upload a usable Playwright results artifact.
  • Shard 3 did not upload a usable Playwright results artifact.
  • Shard 4 did not upload a usable Playwright results artifact.
  • Shard 5 did not upload a usable Playwright results artifact.
  • Shard 6 did not upload a usable Playwright results artifact.
  • Shard 7 did not upload a usable Playwright results artifact.
  • Shard 1 did not upload its execution status.
  • Shard 2 did not upload its execution status.
  • Shard 3 did not upload its execution status.
  • Shard 4 did not upload its execution status.
  • Shard 5 did not upload its execution status.
  • Shard 6 did not upload its execution status.
  • Shard 7 did not upload its execution status.
Shard Passed Failed Flaky Skipped
⛔ Shard 1
⛔ Shard 2
⛔ Shard 3
⛔ Shard 4
⛔ Shard 5
⛔ Shard 6
⛔ Shard 7

📦 Download artifacts

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

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 23, 2026 12:33
@siddhant1
siddhant1 force-pushed the remove-description-outer-card branch from cb22cb5 to 5b8a998 Compare July 23, 2026 12:33

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.

@siddhant1 siddhant1 changed the title fix(ui): remove redundant inner Description card on Domain & Data Product docs fix(ui): drop redundant outer frame card on Domain & Data Product docs Jul 23, 2026
@sonarqubecloud

Copy link
Copy Markdown

Copilot AI review requested due to automatic review settings July 24, 2026 08:47

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.

@siddhant1
siddhant1 enabled auto-merge (squash) July 24, 2026 08:47
@siddhant1 siddhant1 added safe to test Add this label to run secure Github workflows on PRs and removed safe to test Add this label to run secure Github workflows on PRs labels Jul 24, 2026
@siddhant1

Copy link
Copy Markdown
Member Author

Superseded by #30450 — re-opened from a branch on open-metadata/OpenMetadata (this PR's head lived on a fork) so CI runs with full repository access. Continuing there.

@siddhant1 siddhant1 closed this Jul 24, 2026
auto-merge was automatically disabled July 24, 2026 09:05

Pull request was closed

@gitar-bot

gitar-bot Bot commented Jul 24, 2026

Copy link
Copy Markdown
Code Review ✅ Approved 1 resolved / 1 findings

Removes the redundant outer frame card on Domain and Data Product documentation tabs by introducing an opt-in flat variant. Consider verifying whether updating the card's border-radius to rounded-xl unintentionally affects other entity types sharing the description component.

✅ 1 resolved
Quality: Border-radius change affects all entities' Description cards

📄 openmetadata-ui/src/main/resources/ui/src/components/common/EntityDescription/Description.tsx:278-279
This commit changes the wrapInCard branch class from tw:rounded-[10px] to tw:rounded-xl. This branch is used by every entity type that renders the Description with an inner card (tables, dashboards, and now Domain/Data Product too, since their wrapInCard override was removed), so it silently alters the corner radius of Description cards site-wide — unrelated to this PR's stated goal of removing the redundant outer frame. If the radius change is intentional, keep it; otherwise revert to tw:rounded-[10px] to keep the change scoped to the Domain/Data Product frame removal.

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

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 UI UI specific issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants