Skip to content

Commit 602b1e5

Browse files
committed
Update scaffolder templates to use the new, recommended annotation value.
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
1 parent f0f4997 commit 602b1e5

File tree

9 files changed

+15
-7
lines changed

9 files changed

+15
-7
lines changed

catalog-info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ metadata:
1515
url: https://discord.com/invite/EBHEGzX
1616
annotations:
1717
github.com/project-slug: backstage/backstage
18-
backstage.io/techdocs-ref: url:https://github.com/backstage/backstage
18+
backstage.io/techdocs-ref: dir:.
1919
lighthouse.com/website-url: https://backstage.io
2020
spec:
2121
type: library

packages/create-app/templates/default-app/catalog-info.yaml.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ metadata:
66
# Example for optional annotations
77
# annotations:
88
# github.com/project-slug: backstage/backstage
9-
# backstage.io/techdocs-ref: url:https://github.com/backstage/backstage
9+
# backstage.io/techdocs-ref: dir:.
1010
spec:
1111
type: website
1212
owner: john@example.com

plugins/scaffolder-backend/sample-templates/create-react-app/skeleton/catalog-info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
description: {{cookiecutter.description | jsonify}}
66
annotations:
77
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8-
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8+
backstage.io/techdocs-ref: dir:.
99
spec:
1010
type: website
1111
lifecycle: experimental

plugins/scaffolder-backend/sample-templates/create-react-app/skeleton/docs/index.md

Whitespace-only changes.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
site_name: {{cookiecutter.component_id | jsonify}}
2+
site_description: {{cookiecutter.description | jsonify}}
3+
4+
nav:
5+
- Introduction: index.md
6+
7+
plugins:
8+
- techdocs-core

plugins/scaffolder-backend/sample-templates/docs-template/skeleton/catalog-info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
description: {{cookiecutter.description | jsonify}}
66
annotations:
77
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8-
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8+
backstage.io/techdocs-ref: dir:.
99
spec:
1010
type: documentation
1111
lifecycle: experimental

plugins/scaffolder-backend/sample-templates/react-ssr-template/skeleton/catalog-info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
description: {{cookiecutter.description | jsonify}}
66
annotations:
77
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8-
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8+
backstage.io/techdocs-ref: dir:.
99
spec:
1010
type: website
1111
lifecycle: experimental

plugins/scaffolder-backend/sample-templates/springboot-grpc-template/skeleton/catalog-info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
description: {{cookiecutter.description | jsonify}}
66
annotations:
77
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8-
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
8+
backstage.io/techdocs-ref: dir:.
99
spec:
1010
type: service
1111
lifecycle: experimental

plugins/techdocs-backend/examples/documented-component/catalog-info.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ metadata:
44
name: documented-component
55
description: A Service with TechDocs documentation
66
annotations:
7-
backstage.io/techdocs-ref: 'url:https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/examples/documented-component'
7+
backstage.io/techdocs-ref: dir:.
88
spec:
99
type: service
1010
lifecycle: experimental

0 commit comments

Comments
 (0)