techdocs: Add skeleton end-to-end documentation (#1600)

* docs(techdocs): add basic structure * chore: add techdocs-core to docs/features/techdocs * fix: separated out links * fix: convert into markdown table
2020-07-13 17:08:01 +02:00
parent e0211f79bc
commit f2dd70fee5
10 changed files with 51 additions and 0 deletions
@@ -5,6 +5,7 @@
 # https://help.github.com/articles/about-codeowners/

 *                               @spotify/backstage-core
+/docs/features/techdocs         @spotify/techdocs-core
 /plugins/techdocs               @spotify/techdocs-core
 /plugins/techdocs-backend       @spotify/techdocs-core
 /packages/techdocs-cli          @spotify/techdocs-core
@@ -0,0 +1 @@
+# FAQ
@@ -0,0 +1,42 @@
+# TechDocs Documentation
+
+## What is it?
+
+Intro, backstory, etc.
+
+## Structure
+
+- [Getting Started]
+- [Concepts]
+- [Reading Documentation]
+- [Writing Documentation]
+- [Publishing Documentation]
+- [Contributing]
+- [Debugging]
+- [FAQ]
+
+## Tech Stack
+
+| Stack                                       | Location                                                 |
+| ------------------------------------------- | -------------------------------------------------------- |
+| Frontend                                    | [`@backstage/plugin-techdocs`][techdocs/frontend]        |
+| Backend                                     | [`@backstage/plugin-techdocs-backend`][techdocs/backend] |
+| Docker Container (for generating doc sites) | [`packages/techdocs-container`][techdocs/container]      |
+| CLI (for local development)                 | [`packages/techdocs-cli`][techdocs/cli]                  |
+
+[getting started]: getting-started.md
+[concepts]: concepts.md
+[reading documentation]: reading-documentation.md
+[writing documentation]: writing-documentation.md
+[publishing documentation]: publishing-documentation.md
+[contributing]: contributing.md
+[debugging]: debugging.md
+[faq]: FAQ.md 'Frequently asked questions'
+[techdocs/frontend]:
+  https://github.com/spotify/backstage/blob/master/plugins/techdocs
+[techdocs/backend]:
+  https://github.com/spotify/backstage/blob/master/plugins/techdocs-backend
+[techdocs/container]:
+  https://github.com/spotify/backstage/blob/master/packages/techdocs-container
+[techdocs/cli]:
+  https://github.com/spotify/backstage/blob/master/packages/techdocs-cli
@@ -0,0 +1 @@
+# Concepts
@@ -0,0 +1 @@
+# Contributing
@@ -0,0 +1 @@
+# Debugging
@@ -0,0 +1 @@
+# Getting Started
@@ -0,0 +1 @@
+# Publishing Documentation
@@ -0,0 +1 @@
+# Reading Documentation
@@ -0,0 +1 @@
+# Writing Documentation