backstage/backstage

馃殌 Feature: Use the Catalog presentation API

Open

#20955 opened on Nov 3, 2023

View on GitHub
聽(22 comments)聽(0 reactions)聽(0 assignees)TypeScript聽(26,101 stars)聽(5,277 forks)batch import
area:cataloggood first issuepriority:contrib-needed

Description

馃敄 Feature description

Now that #17474 is merged, let's use the presentation APIs all over the place! This should help with ensuring that entities are presented uniformly with their titles / display names / etc, and with the same iconography everywhere if applicable.

馃帳 Context

See #17474

鉁岋笍 Possible Implementation

Places in the code that use EntityRefLink/EntityRefLinks are already covered.

All humanizeEntityRef and humanizeEntity call sites have been removed (see #33576, #33386, #33818). Only the deprecated definitions and re-exports remain in @backstage/plugin-catalog-react.

The remaining work is migrating places that directly access metadata.title, spec.profile.displayName, or plain metadata.name for display purposes. Those should use the EntityDisplayName React component if possible, or entityPresentationSnapshot in non-React contexts.

We'd appreciate the help with digging through the Backstage core and plugins, finding places where the presentation API should be used.

馃憖 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

Are you willing to submit PR?

No, but I'm happy to collaborate on a PR with someone else

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptReactBackstage catalog concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Search the Backstage codebase for direct accesses to metadata.title, spec.profile.displayName, or metadata.name in React components (JSX) and non React contexts. Replace these with the EntityDisplayName component or the entityPresentationSnapshot function as appropriate. Look at the existing PRs #33576, #33386, and #33818 for examples of similar migrations. The issue comments may provide additional guidance on remaining areas.