Document browser URL annotations
This commit is contained in:
committed by
James Turley
parent
a51094aac8
commit
a4f863f8f8
@@ -166,6 +166,7 @@ interop
|
||||
jq
|
||||
js
|
||||
json
|
||||
jsonnet
|
||||
jsx
|
||||
kubectl
|
||||
kubernetes
|
||||
|
||||
@@ -70,6 +70,25 @@ The value of this annotation is a location reference string (see above). If this
|
||||
annotation is specified, it is expected to point to a repository that the
|
||||
TechDocs system can read and generate docs from.
|
||||
|
||||
### backstage.io/browser-view-url, backstage.io/browser-edit-url, backstage.io/browser-source-url
|
||||
|
||||
```yaml
|
||||
# Example:
|
||||
metadata:
|
||||
annotations:
|
||||
backstage.io/browser-view-url: https://some.website/catalog-info.yaml
|
||||
backstage.io/browser-edit-url: https://github.com/my-org/catalog/edit/master/my-service.jsonnet
|
||||
backstage.io/browser-source-url: https://github.com/my-org/my-service
|
||||
```
|
||||
|
||||
These annotations allow customising links from the catalog pages. The view URL
|
||||
should point to the canonical metadata YAML that governs this entity. The edit
|
||||
URL should point to the source file for the metadata. The source URL should
|
||||
point to the source code of the entity itself (where relevant, i.e. when the
|
||||
entity is a `Component`). In the example above, `my-org` generates its catalog
|
||||
data from Jsonnet files in a monorepo, and so for the `my-service` component, we
|
||||
need three custom links.
|
||||
|
||||
### jenkins.io/github-folder
|
||||
|
||||
```yaml
|
||||
|
||||
Reference in New Issue
Block a user