Update scaffolder templates to use the new, recommended annotation va…

…lue. Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
soprasteria · Jul 28, 2021 · 602b1e5 · 602b1e5
1 parent f0f4997
commit 602b1e5
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 7 deletions.
diff --git a/catalog-info.yaml b/catalog-info.yaml
@@ -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

diff --git a/packages/create-app/templates/default-app/catalog-info.yaml.hbs b/packages/create-app/templates/default-app/catalog-info.yaml.hbs
@@ -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

diff --git a/plugins/scaffolder-backend/sample-templates/create-react-app/skeleton/catalog-info.yaml b/plugins/scaffolder-backend/sample-templates/create-react-app/skeleton/catalog-info.yaml
@@ -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

diff --git a/...ins/scaffolder-backend/sample-templates/create-react-app/skeleton/docs/index.md b/...ins/scaffolder-backend/sample-templates/create-react-app/skeleton/docs/index.md
diff --git a/plugins/scaffolder-backend/sample-templates/create-react-app/skeleton/mkdocs.yml b/plugins/scaffolder-backend/sample-templates/create-react-app/skeleton/mkdocs.yml
@@ -0,0 +1,8 @@
+site_name: {{cookiecutter.component_id | jsonify}}
+site_description: {{cookiecutter.description | jsonify}}
+
+nav:
+  - Introduction: index.md
+
+plugins:
+  - techdocs-core
diff --git a/plugins/scaffolder-backend/sample-templates/docs-template/skeleton/catalog-info.yaml b/plugins/scaffolder-backend/sample-templates/docs-template/skeleton/catalog-info.yaml
@@ -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

diff --git a/plugins/scaffolder-backend/sample-templates/react-ssr-template/skeleton/catalog-info.yaml b/plugins/scaffolder-backend/sample-templates/react-ssr-template/skeleton/catalog-info.yaml
@@ -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

diff --git a/...s/scaffolder-backend/sample-templates/springboot-grpc-template/skeleton/catalog-info.yaml b/...s/scaffolder-backend/sample-templates/springboot-grpc-template/skeleton/catalog-info.yaml
@@ -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

diff --git a/plugins/techdocs-backend/examples/documented-component/catalog-info.yaml b/plugins/techdocs-backend/examples/documented-component/catalog-info.yaml
@@ -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