[Fixes 5420] Update component example in documentation

Currently the entity component example towards the top of the page
has metadata.labels.system set
https://github.com/backstage/backstage/blame/master/docs/features/software-catalog/descriptor-format.md#L47
but further down on the page it's spec.system
https://github.com/backstage/backstage/blame/master/docs/features/software-catalog/descriptor-format.md#L423.

This updates them to both use the correct spec.system key/value,
as well as add an example label to get a sense for what labels
look like as well

Signed-off-by: jrusso1020 <jrusso@brex.com>
This commit is contained in:
jrusso1020
2021-04-22 09:08:46 -06:00
parent 08a022fcdf
commit 5461726742
@@ -44,7 +44,7 @@ metadata:
name: artist-web
description: The place to be, for great artists
labels:
system: public-websites
backstage.io/custom: ValueStuff
annotations:
example.com/service-discovery: artistweb
circleci.com/project-slug: github/example-org/artist-website
@@ -58,6 +58,7 @@ spec:
type: website
lifecycle: production
owner: artist-relations-team
system: public-websites
```
This is the same entity as returned in JSON from the software catalog API:
@@ -76,7 +77,7 @@ This is the same entity as returned in JSON from the software catalog API:
"etag": "ZjU2MWRkZWUtMmMxZS00YTZiLWFmMWMtOTE1NGNiZDdlYzNk",
"generation": 1,
"labels": {
"system": "public-websites"
"backstage.io/custom": "ValueStuff"
},
"links": [{
"url": "https://admin.example-org.com",
@@ -90,7 +91,8 @@ This is the same entity as returned in JSON from the software catalog API:
"spec": {
"lifecycle": "production",
"owner": "artist-relations-team",
"type": "website"
"type": "website",
"system": "public-websites"
}
}
```