diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 1aadbbf981..8b07e1a51a 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -247,8 +247,8 @@ i.e. not Backstage specific but the same as in Kubernetes. ### `title` [optional] -A nice display name of the entity, to be presented in user interfaces instead of -the `name` property above, when available. +A display name of the entity, to be presented in user interfaces instead of the +`name` property above, when available. This field is sometimes useful when the `name` is cumbersome or ends up being perceived as overly technical. The title generally does not have as stringent diff --git a/packages/catalog-model/src/entity/Entity.ts b/packages/catalog-model/src/entity/Entity.ts index 5b20d72c6f..681ac43b80 100644 --- a/packages/catalog-model/src/entity/Entity.ts +++ b/packages/catalog-model/src/entity/Entity.ts @@ -119,8 +119,8 @@ export type EntityMeta = JsonObject & { namespace?: string; /** - * A nice display name of the entity, to be presented in user interfaces - * instead of the `name` property above, when available. + * A display name of the entity, to be presented in user interfaces instead + * of the `name` property above, when available. * * This field is sometimes useful when the `name` is cumbersome or ends up * being perceived as overly technical. The title generally does not have diff --git a/packages/catalog-model/src/schema/EntityMeta.schema.json b/packages/catalog-model/src/schema/EntityMeta.schema.json index 105b698940..c834bfb113 100644 --- a/packages/catalog-model/src/schema/EntityMeta.schema.json +++ b/packages/catalog-model/src/schema/EntityMeta.schema.json @@ -55,7 +55,7 @@ }, "title": { "type": "string", - "description": "A nice display name of the entity, to be presented in user interfaces instead of the name property, when available.", + "description": "A display name of the entity, to be presented in user interfaces instead of the name property, when available.", "examples": ["React SSR Template"], "minLength": 1 },