fix(techdocs-docs-concepts): TechDocs concept documentation

2020-07-21 15:02:36 +02:00
parent a6b33a0faf
commit 4f5ed073f3
1 changed files with 44 additions and 5 deletions
@@ -3,11 +3,50 @@
 This page describes concepts that has been introduced with Spotify's
 docs-like-code solution in Backstage.

+### TechDocs Core Plugin
+
+The TechDocs Core Plugin is a MkDocs plugin created as a wrapper around multiple
+MkDocs plugins and Python Markdown extensions to standardize the configuration
+of MkDocs used for TechDocs.
+
+[TechDocs Core](../../../packages/techdocs-container/techdocs-core/README.md)
+
+### TechDocs container
+
+The TechDocs container is a Docker container that builds the HTML documentation
+pages from Python flavoured markdown through MkDocs, including e.g. buttons
+(more here) and styles.
+
+[TechDocs Container](../../../packages/techdocs-container/README.md)
+
+### TechDocs publisher (Coming Soon)
+
+### TechDocs CLI
+
+The TechDocs CLI was created to make it easy to write, generate and preview
+documentation for publishing. Currently it mostly acts as a wrapper around the
+TechDocs container and provides a easy to use interface for our docker
+container.
+
+[TechDocs CLI](../../../packages/techdocs-cli/README.md)
+
+### TechDocs Reader
+
+Documentation generated by TechDocs is generated as static html sites. The
+TechDocs Reader was therefore created to be able to integrate pre-generated html
+sites with the Backstage UI.
+
+The TechDocs Reader purpose is also to open up the opportunity to integrate
+TechDocs widgets for a customized full-featured TechDocs experience.
+([Coming Soon V.2](https://github.com/spotify/backstage/milestone/17))
+
+[TechDocs Reader](../../../plugins/techdocs/src/reader/README.md)
+
 ### Transformers

-Transformers is an abstraction of functionality that are responsible for
-different things. The reason to why transformers were introduced is to provide a
-others to be able to switch out transformers as it fits your TechDocs solution.
+Transformers is different pieces of functionality used inside the TechDocs
+Reader. The reason to why transformers were introduced is to provide a way to
+transform the html content on pre and post render. (e.g. rewrite docs links or
+modify css)

-Interested in how transformers work?
-[Read more here.](../../../plugins/techdocs/src/reader/transformers/README.md)
+[Transformers API docs](../../../plugins/techdocs/src/reader/transformers/README.md)