Skip to content

Docs: Update custom properties page for 2.1 tab redesign - #614

Merged
kiran1287 merged 1 commit into
mainfrom
docs/583-custom-properties-2-1
Oct 19, 2026
Merged

kiran1287 merged 1 commit into
mainfrom
docs/583-custom-properties-2-1

Conversation

@kiran1287

Copy link
Copy Markdown
Contributor

Part of #583 (OpenMetadata-only scope).

What changed

v2.1.x-SNAPSHOT/how-to-guides/guide-for-data-users/custom.mdx:

  • Documents the redesigned Custom Properties tab (OpenMetadata#34042): search, sort, property cards, and the add/edit value window with per-type editors.
  • Replaces the supported-types list with a table (type and one-line description) and adds the missing Hyperlink type.
  • Rewrites "create a custom property" as numbered steps with new screenshots, including Display Name and Show Help Text.
  • Adds a "Manage Custom Properties" section with edit and delete steps, screenshots, and a warning that deleting a property also removes its stored values.

Not included

The rest of #583 is Collate/AI-mode only (profile page, Bots, Governance, inline custom properties panel, auto-classification toggle) or already documented (persona App Layout, per-user preferences). See the updated issue body.

Checks

  • Reviewed against .ai/doc-review checklist; all findings fixed.
  • Claims checked against the OpenMetadata schema and source. Not previewed with mint dev.

Document the redesigned Custom Properties tab (search, sort, cards, add/edit window), add a supported types table, and add steps for creating, editing, and deleting custom properties with new screenshots. Part of #583.
@mintlify

mintlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
openmetadata 🟢 Ready View Preview Oct 16, 2026, 6:25 PM

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

@github-actions

Copy link
Copy Markdown

Review Report

Content type: Documentation
Overall verdict: NEEDS WORK
Reason: Critical=0, Major=1, Minor=2.
Reviewed revision: 22084ba
Findings: Critical=0 Major=1 Minor=2

Issues Found

# Guideline Severity Original text Suggested change
1 Consistent terminology (Category 2): use one name for each feature or page. Major "sidebarTitle: How to Create a Custom Property for a Data Asset" (custom.mdx:4) The title and H1 are now "Create a Custom Property for a Data Asset", but sidebarTitle still has the old "How to…" wording. Change sidebarTitle to "Create a Custom Property for a Data Asset".
2 Capitalization (Category 5): do not capitalize generic technical terms. Minor "To create a Custom Property:" (custom.mdx, "Create a Custom Property" section) Use lowercase "custom property" in body text, as in the rest of the page: "To create a custom property:". Keep title case in headings.
3 Customer-facing messages (Category 10): address the reader as "you", not "users". Minor "Other users can view the values but not change them." (custom.mdx, Note after "Add or Edit a Value") Rephrase to address the reader: "Without that permission, you can view the values but not change them."

View job · claude-sonnet-5-5 (high) · full

@kiran1287 kiran1287 linked an issue Oct 16, 2026 that may be closed by this pull request
3 tasks done
@kiran1287 kiran1287 self-assigned this Oct 16, 2026
@kiran1287 kiran1287 added the 2.1 OpenMetadata 2.1 release documentation label Oct 16, 2026

@ayush-shah ayush-shah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Reviewed the documentation diff, affected context, screenshots, and existing discussion at 22084ba. No actionable diff-caused findings in this documentation review.

@kiran1287
kiran1287 merged commit ac74d58 into main Oct 19, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
staging — 22084ba3 Deployed Oct 16, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2.1 OpenMetadata 2.1 release documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[2.1 Docs] UI & Admin: profile page, preferences/persona, custom properties

2 participants