From 9e2606a89a7a4e7b8608cf820f83f645f2329df7 Mon Sep 17 00:00:00 2001
From: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
Date: Wed, 22 Jul 2020 16:44:14 +0200
Subject: [PATCH] feature(techdocs): added an example component in
 techdocs-backend containing a documentation reference

---
 .../examples/documented-component/docs/index.md      |  3 +++
 .../documented-component/documented-component.yaml   | 11 +++++++++++
 .../examples/documented-component/mkdocs.yml         |  7 +++++++
 plugins/techdocs-backend/package.json                |  3 ++-
 plugins/techdocs-backend/scripts/mock-data.sh        | 12 ++++++++++++
 5 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 plugins/techdocs-backend/examples/documented-component/docs/index.md
 create mode 100644 plugins/techdocs-backend/examples/documented-component/documented-component.yaml
 create mode 100644 plugins/techdocs-backend/examples/documented-component/mkdocs.yml
 create mode 100755 plugins/techdocs-backend/scripts/mock-data.sh

diff --git a/plugins/techdocs-backend/examples/documented-component/docs/index.md b/plugins/techdocs-backend/examples/documented-component/docs/index.md
new file mode 100644
index 0000000000..bf0895710f
--- /dev/null
+++ b/plugins/techdocs-backend/examples/documented-component/docs/index.md
@@ -0,0 +1,3 @@
+# example docs
+
+This is a basic example of documentation.
diff --git a/plugins/techdocs-backend/examples/documented-component/documented-component.yaml b/plugins/techdocs-backend/examples/documented-component/documented-component.yaml
new file mode 100644
index 0000000000..64eba5598b
--- /dev/null
+++ b/plugins/techdocs-backend/examples/documented-component/documented-component.yaml
@@ -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
diff --git a/plugins/techdocs-backend/examples/documented-component/mkdocs.yml b/plugins/techdocs-backend/examples/documented-component/mkdocs.yml
new file mode 100644
index 0000000000..deb46069d7
--- /dev/null
+++ b/plugins/techdocs-backend/examples/documented-component/mkdocs.yml
@@ -0,0 +1,7 @@
+site_name: 'example-docs'
+
+nav:
+  - Home: index.md
+
+plugins:
+  - techdocs-core
\ No newline at end of file
diff --git a/plugins/techdocs-backend/package.json b/plugins/techdocs-backend/package.json
index 03a6a8dcb9..b66509abe5 100644
--- a/plugins/techdocs-backend/package.json
+++ b/plugins/techdocs-backend/package.json
@@ -17,7 +17,8 @@
     "test": "backstage-cli test",
     "prepack": "backstage-cli prepack",
     "postpack": "backstage-cli postpack",
-    "clean": "backstage-cli clean"
+    "clean": "backstage-cli clean",
+    "mock-data": "./scripts/mock-data.sh"
   },
   "dependencies": {
     "@backstage/backend-common": "^0.1.1-alpha.15",
diff --git a/plugins/techdocs-backend/scripts/mock-data.sh b/plugins/techdocs-backend/scripts/mock-data.sh
new file mode 100755
index 0000000000..0630490694
--- /dev/null
+++ b/plugins/techdocs-backend/scripts/mock-data.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+for URL in \
+  'documented-component/documented-component.yaml' \
+; do \
+  curl \
+    --location \
+    --request POST 'localhost:7000/catalog/locations' \
+    --header 'Content-Type: application/json' \
+    --data-raw "{\"type\": \"file\", \"target\": \"$(pwd)/examples/${URL}\"}"
+  echo
+done