address comments

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2021-05-17 10:47:08 +02:00
parent 68fdbf014e
commit 21ebf8dd5e
4 changed files with 23 additions and 19 deletions
@@ -417,7 +417,7 @@ follows.
{
// ...
"status": {
"backstage.io/processing-status": {
"backstage.io/catalog-processing": {
"errors": []
}
},
@@ -428,9 +428,9 @@ follows.
```
The keys of the `status` object are arbitrary strings. We recommend that any
statuses, that are not strictly private within the organization, be namespaced
to avoid collisions. Statuses emitted by Backstage core processes will for
example be prefixed with `backstage.io/` as in the example above.
statuses that are not strictly private within the organization be namespaced to
avoid collisions. Statuses emitted by Backstage core processes will for example
be prefixed with `backstage.io/` as in the example above.
The values of the `status` object are currently left unrestricted, except that
they must be objects. We reserve the right to extend this model in the future,
@@ -27,7 +27,7 @@ a standard concept of "severity" or "level" to these.
This is a (non-exhaustive) list of statuses that are known to be in active use.
### `backstage.io/processing-status`
### `backstage.io/catalog-processing`
Contains the current status of the catalog's ingestion of this entity. Errors
that may appear here include inability to read from the remote SCM provider,
@@ -42,7 +42,7 @@ successfully ingested. This is normal.
```yaml
# Example:
status:
backstage.io/processing-status:
backstage.io/catalog-processing:
errors: []
```