From f2dd70fee5eaf5f74e624e86ae56c3240c8bc338 Mon Sep 17 00:00:00 2001 From: Bilawal Hameed Date: Mon, 13 Jul 2020 17:08:01 +0200 Subject: [PATCH] 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 --- .github/CODEOWNERS | 1 + docs/features/techdocs/FAQ.md | 1 + docs/features/techdocs/README.md | 42 +++++++++++++++++++ docs/features/techdocs/concepts.md | 1 + docs/features/techdocs/contributing.md | 1 + docs/features/techdocs/debugging.md | 1 + docs/features/techdocs/getting-started.md | 1 + .../techdocs/publishing-documentation.md | 1 + .../techdocs/reading-documentation.md | 1 + .../techdocs/writing-documentation.md | 1 + 10 files changed, 51 insertions(+) create mode 100644 docs/features/techdocs/FAQ.md create mode 100644 docs/features/techdocs/README.md create mode 100644 docs/features/techdocs/concepts.md create mode 100644 docs/features/techdocs/contributing.md create mode 100644 docs/features/techdocs/debugging.md create mode 100644 docs/features/techdocs/getting-started.md create mode 100644 docs/features/techdocs/publishing-documentation.md create mode 100644 docs/features/techdocs/reading-documentation.md create mode 100644 docs/features/techdocs/writing-documentation.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d9f9d2ccbe..d737dd620e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -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 diff --git a/docs/features/techdocs/FAQ.md b/docs/features/techdocs/FAQ.md new file mode 100644 index 0000000000..4514b4c106 --- /dev/null +++ b/docs/features/techdocs/FAQ.md @@ -0,0 +1 @@ +# FAQ diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md new file mode 100644 index 0000000000..338d4af144 --- /dev/null +++ b/docs/features/techdocs/README.md @@ -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 diff --git a/docs/features/techdocs/concepts.md b/docs/features/techdocs/concepts.md new file mode 100644 index 0000000000..74d42e13cd --- /dev/null +++ b/docs/features/techdocs/concepts.md @@ -0,0 +1 @@ +# Concepts diff --git a/docs/features/techdocs/contributing.md b/docs/features/techdocs/contributing.md new file mode 100644 index 0000000000..854139a319 --- /dev/null +++ b/docs/features/techdocs/contributing.md @@ -0,0 +1 @@ +# Contributing diff --git a/docs/features/techdocs/debugging.md b/docs/features/techdocs/debugging.md new file mode 100644 index 0000000000..1e584c954d --- /dev/null +++ b/docs/features/techdocs/debugging.md @@ -0,0 +1 @@ +# Debugging diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md new file mode 100644 index 0000000000..bad55622f9 --- /dev/null +++ b/docs/features/techdocs/getting-started.md @@ -0,0 +1 @@ +# Getting Started diff --git a/docs/features/techdocs/publishing-documentation.md b/docs/features/techdocs/publishing-documentation.md new file mode 100644 index 0000000000..9d1bac187a --- /dev/null +++ b/docs/features/techdocs/publishing-documentation.md @@ -0,0 +1 @@ +# Publishing Documentation diff --git a/docs/features/techdocs/reading-documentation.md b/docs/features/techdocs/reading-documentation.md new file mode 100644 index 0000000000..f872ed5df8 --- /dev/null +++ b/docs/features/techdocs/reading-documentation.md @@ -0,0 +1 @@ +# Reading Documentation diff --git a/docs/features/techdocs/writing-documentation.md b/docs/features/techdocs/writing-documentation.md new file mode 100644 index 0000000000..5fea01bcad --- /dev/null +++ b/docs/features/techdocs/writing-documentation.md @@ -0,0 +1 @@ +# Writing Documentation