More review comments

This commit is contained in:
Dominik Henneke
2021-01-20 10:14:56 +01:00
parent 4b5c4cc5ce
commit b0d50574d3
2 changed files with 7 additions and 7 deletions
@@ -22,7 +22,7 @@ use.
# Example:
metadata:
annotations:
backstage.io/managed-by-location: github:http://github.com/backstage/backstage/catalog-info.yaml
backstage.io/managed-by-location: url:http://github.com/backstage/backstage/catalog-info.yaml
```
The value of this annotation is a so called location reference string, that
@@ -30,8 +30,8 @@ points to the source from which the entity was originally fetched. This
annotation is added automatically by the catalog as it fetches the data from a
registered location, and is not meant to normally be written by humans. The
annotation may point to any type of generic location that the catalog supports,
so it cannot be relied on to always be specifically of type `github`, nor that
it even represents a single file. Note also that a single location can be the
so it cannot be relied on to always be specifically of type `url`, nor that it
even represents a single file. Note also that a single location can be the
source of many entities, so it represents a many-to-one relationship.
The format of the value is `<type>:<target>`. Note that the target may also
@@ -46,7 +46,7 @@ colon is always present.
# Example:
metadata:
annotations:
backstage.io/managed-by-origin-location: github:http://github.com/backstage/backstage/catalog-info.yaml
backstage.io/managed-by-origin-location: url:http://github.com/backstage/backstage/catalog-info.yaml
```
The value of this annotation is a location reference string (see above). It
@@ -55,7 +55,7 @@ In most cases, the `backstage.io/managed-by-location` and
`backstage.io/managed-by-origin-location` will be equal. They will be different
if the original location delegates to another location. A common case is, that a
location is registered as `bootstrap:boostrap` which means that it is part of
the `app-config.yaml` of a backstage installation.
the `app-config.yaml` of a Backstage installation.
### backstage.io/techdocs-ref
@@ -63,7 +63,7 @@ the `app-config.yaml` of a backstage installation.
# Example:
metadata:
annotations:
backstage.io/techdocs-ref: github:https://github.com/backstage/backstage.git
backstage.io/techdocs-ref: url:https://github.com/backstage/backstage.git
```
The value of this annotation is a location reference string (see above). If this
@@ -112,7 +112,7 @@ export const UnregisterEntityDialog = ({
{`"${(error as DeniedLocationException).locationName}"`}). If
you believe this is in error, please contact the{' '}
{configApi.getOptionalString('app.title') ?? 'Backstage'}{' '}
operator.
integrator.
</>
) : (
error.toString()