docs: tweak docs for backstage.io/source-location

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-14 10:46:47 +02:00
parent b9521b83ed
commit f361f9e9dd
1 changed files with 4 additions and 2 deletions
@@ -92,12 +92,14 @@ view and edit links need changing.
 # Example:
 metadata:
  annotations:
-    backstage.io/source-location: github:https://github.com/my-org/my-service
+    backstage.io/source-location: url:https://github.com/my-org/my-service/
 ```

 A `Location` reference that points to the source code of the entity (typically a
 `Component`). Useful when catalog files do not get ingested from the source code
-repository itself.
+repository itself. If the URL points to a folder, it is important that it is
+suffixed with a `'/'` in order for relative path resolution to work
+consistently.

 ### jenkins.io/github-folder