Skip to content

As a Backstage user (i.e., not entity owner), the copy for missing docs is a little confusing  #14064

@anilazaidi

Description

@anilazaidi

Currently, a user sees the copy/image below when an entity doesn't use the annotation for TechDocs:

image

Not all Backstage users are entity owners, so this may cause confusion (e.g., "The copy says I need to do something, but I didn't even add this entity...")

Feature Suggestion

If Spotify's goal is to foster docs collaboration between Backstage users and Backstage entity owners, then I wonder if the copy for this missing annotation can be improved to something like this:

# Missing documentation

This entity doesn't have documentation generated via TechDocs; contact the entity owner to learn why. 

If you're curious about TechDocs and how it generates documentation via the catalog-info annotation below, read the [Backstage guide](https://backstage.io/docs/features/software-catalog/well-known-annotations#backstageiotechdocs-ref).

Context

When navigating around Backstage with an engineer who wasn't an entity owner, they were confused by this copy when they clicked on the Docs tab.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions