Update scaffolder templates to use the new, recommended annotation value.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-07-28 18:43:49 +02:00
parent f0f4997f96
commit 602b1e5c97
9 changed files with 15 additions and 7 deletions
+1 -1
View File
@@ -15,7 +15,7 @@ metadata:
url: https://discord.com/invite/EBHEGzX
annotations:
github.com/project-slug: backstage/backstage
backstage.io/techdocs-ref: url:https://github.com/backstage/backstage
backstage.io/techdocs-ref: dir:.
lighthouse.com/website-url: https://backstage.io
spec:
type: library
@@ -6,7 +6,7 @@ metadata:
# Example for optional annotations
# annotations:
# github.com/project-slug: backstage/backstage
# backstage.io/techdocs-ref: url:https://github.com/backstage/backstage
# backstage.io/techdocs-ref: dir:.
spec:
type: website
owner: john@example.com
@@ -5,7 +5,7 @@ metadata:
description: {{cookiecutter.description | jsonify}}
annotations:
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: dir:.
spec:
type: website
lifecycle: experimental
@@ -0,0 +1,8 @@
site_name: {{cookiecutter.component_id | jsonify}}
site_description: {{cookiecutter.description | jsonify}}
nav:
- Introduction: index.md
plugins:
- techdocs-core
@@ -5,7 +5,7 @@ metadata:
description: {{cookiecutter.description | jsonify}}
annotations:
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: dir:.
spec:
type: documentation
lifecycle: experimental
@@ -5,7 +5,7 @@ metadata:
description: {{cookiecutter.description | jsonify}}
annotations:
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: dir:.
spec:
type: website
lifecycle: experimental
@@ -5,7 +5,7 @@ metadata:
description: {{cookiecutter.description | jsonify}}
annotations:
github.com/project-slug: {{cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: url:{{"https://" + cookiecutter.destination.host + "/" + cookiecutter.destination.owner + "/" + cookiecutter.destination.repo}}
backstage.io/techdocs-ref: dir:.
spec:
type: service
lifecycle: experimental
@@ -4,7 +4,7 @@ metadata:
name: documented-component
description: A Service with TechDocs documentation
annotations:
backstage.io/techdocs-ref: 'url:https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/examples/documented-component'
backstage.io/techdocs-ref: dir:.
spec:
type: service
lifecycle: experimental