docs: updated to packages/techdocs-container

2020-07-10 16:17:22 +02:00
parent decf400b4b
commit 68d472f702
5 changed files with 23 additions and 15 deletions
@@ -1,15 +1,23 @@
-# MkDocs
+# techdocs-container

-Welcome to MkDocs. This is the TechDocs implementation of MkDocs.
+This is the Docker container that powers the creation of static documentation sites that are supported by [TechDocs](https://github.com/spotify/backstage/blob/master/plugins/techdocs).

 **WIP: This is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).**

-## Getting started
+## Getting Started
+
+Using the TechDocs CLI, we can invoke the latest version of `techdocs-container` via Docker Hub:

 ```bash
-docker build ./container -t mkdocs-container
+npx @techdocs/cli serve:container
+```

-docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs-container serve -a 0.0.0.0:8000
+## Local Development
+
+```bash
+docker build ./container -t techdocs-container
+
+docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it techdocs-container serve -a 0.0.0.0:8000
 ```

 Then open up `http://localhost:8000` on your local machine.
@@ -33,7 +33,7 @@ You'll then have the `techdocs-core` package available to use in Mkdocs and `pip

 In the parent `Dockerfile` we add this folder to the build and install the package locally in the container. In the future, we'll probably move away from this approach and have it download directly from a Python registry (and this folder will publish to one).

-See the `README.md` located in the `mkdocs/` folder for more details on how to build and run the Docker container.
+See the `README.md` located in the `techdocs-container/` folder for more details on how to build and run the Docker container.

 ## Linting