feature(techdocs): added an example component in techdocs-backend containing a documentation reference

2020-07-22 16:44:14 +02:00
parent dfa34bdb3e
commit 9e2606a89a
5 changed files with 35 additions and 1 deletions
@@ -0,0 +1,3 @@
+# example docs
+
+This is a basic example of documentation.
@@ -0,0 +1,11 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: documented-component
+  description: A Service with TechDocs documentation
+  annotations:
+    spotify.com/techdocs-ref: 'dir:./'
+spec:
+  type: service
+  lifecycle: experimental
+  owner: documented@example.com
@@ -0,0 +1,7 @@
+site_name: 'example-docs'
+
+nav:
+  - Home: index.md
+
+plugins:
+  - techdocs-core