From 6406d8f86367ce02f4404678a7c7f702d80b42c4 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 21 Jul 2020 08:34:06 +0200 Subject: [PATCH 1/2] fix(techdocs-faq-docs): Add section to FAQ --- docs/features/techdocs/FAQ.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/features/techdocs/FAQ.md b/docs/features/techdocs/FAQ.md index 4514b4c106..ee9a40c983 100644 --- a/docs/features/techdocs/FAQ.md +++ b/docs/features/techdocs/FAQ.md @@ -1 +1,29 @@ -# FAQ +# TechDocs FAQ + +This page answer frequently asked questions about [TechDocs]. + +#### Technology + +- [What static site generator is TechDocs using?](./#what-static-site-generator-is-techdocs-using) +- [What is the mkdocs-techdocs-core plugin?](./#what-is-the-mkdocs-techdocs-core-plugin) + +## What static site generator is TechDocs using? + +TechDocs is using [MkDocs](https://www.mkdocs.org/) to build project +doucmentation under the hood. Documentation built with the +[techdocs-container](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/README.md) +is using the MkDocs Material Theme. + +## What is the mkdocs-techdocs-core plugin? + +The +[mkdocs-techdocs-core](https://github.com/spotify/backstage/blob/master/packages/techdocs-container/techdocs-core/README.md) +package is a MkDocs Plugin that works like a wrapper around multiple MkDocs +plugins (e.g. +[MkDocs Monorepo Plugin](https://github.com/spotify/mkdocs-monorepo-plugin)) as +well as a selection of Python Markdown extensions that TechDocs supports. + +_Add a question that you think others might be interested in? Edit the file +[here](https://github.com/spotify/backstage/edit/master/docs/features/techdocs/FAQ.md)._ + +[techdocs]: README.md From 04114524ca4eda21c62def3ae561d97da4a5f261 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 21 Jul 2020 08:34:37 +0200 Subject: [PATCH 2/2] fix(techdocs-core): update installation instructions --- packages/techdocs-container/techdocs-core/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/techdocs-container/techdocs-core/README.md b/packages/techdocs-container/techdocs-core/README.md index 12b3acb1e2..9608780bd2 100644 --- a/packages/techdocs-container/techdocs-core/README.md +++ b/packages/techdocs-container/techdocs-core/README.md @@ -2,9 +2,13 @@ This is the base [Mkdocs](https://mkdocs.org) plugin used when using Mkdocs with Spotify's TechDocs. It is written in Python and packages all of our Mkdocs defaults, such as theming, plugins, etc in a single plugin. +[Python Package](https://pypi.org/project/mkdocs-techdocs-core/) + ## Usage -**Installation instructions TBD.** We haven't published it to a Python registry yet. +```bash +$ pip install mkdocs-techdocs-core +``` Once you have installed the `mkdocs-techdocs-core` plugin, you'll need to add it to your `mkdocs.yml`.