Merge pull request #6639 from backstage/techdocs/ref-follow-ups

[TechDocs] Remove deprecated preparer support and document ref values
This commit is contained in:
Eric Peterson
2021-08-03 09:21:38 +02:00
committed by GitHub
27 changed files with 119 additions and 809 deletions
@@ -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