Merge pull request #1413 from spotify/mob/mkdocs

techdocs: MkDocs docker container skeleton
This commit is contained in:
Emma Indal
2020-06-23 11:38:23 +02:00
committed by GitHub
5 changed files with 29 additions and 0 deletions
+4
View File
@@ -4,6 +4,10 @@ Welcome to the TechDocs plugin - Spotify's docs-like-code approach built directl
**WIP: This plugin 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).**
## Sections
- [MkDocs](./mkdocs/README.md)
## Getting started
Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/techdocs](http://localhost:3000/techdocs).
+13
View File
@@ -0,0 +1,13 @@
# MkDocs
Welcome to MkDocs. This is the TechDocs implementation of MkDocs.
**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
```
docker build ./container -t mkdocs-container
docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs-container serve -a 0.0.0.0:8000 --theme material
```
@@ -0,0 +1,7 @@
FROM python:3.7.7-alpine3.12
RUN apk update && apk --no-cache add gcc musl-dev
RUN pip install mkdocs==1.1.2 mkdocs-material==5.3.2
ENTRYPOINT [ "mkdocs" ]
@@ -0,0 +1 @@
## hello mock docs
@@ -0,0 +1,4 @@
site_name: 'mock-docs'
nav:
- Home: index.md