From 2fcf69673127e6a5de512b0a757555d661bffb26 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 11:20:39 +0200 Subject: [PATCH 1/5] feat(mkdocs): mkdocs docker container --- plugins/techdocs/mkdocs/container/Dockerfile | 7 +++++++ plugins/techdocs/mkdocs/mock-docs/docs/index.md | 1 + plugins/techdocs/mkdocs/mock-docs/mkdocs.yml | 4 ++++ 3 files changed, 12 insertions(+) create mode 100644 plugins/techdocs/mkdocs/container/Dockerfile create mode 100644 plugins/techdocs/mkdocs/mock-docs/docs/index.md create mode 100644 plugins/techdocs/mkdocs/mock-docs/mkdocs.yml diff --git a/plugins/techdocs/mkdocs/container/Dockerfile b/plugins/techdocs/mkdocs/container/Dockerfile new file mode 100644 index 0000000000..89ca705095 --- /dev/null +++ b/plugins/techdocs/mkdocs/container/Dockerfile @@ -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" ] + diff --git a/plugins/techdocs/mkdocs/mock-docs/docs/index.md b/plugins/techdocs/mkdocs/mock-docs/docs/index.md new file mode 100644 index 0000000000..1da6f7d43e --- /dev/null +++ b/plugins/techdocs/mkdocs/mock-docs/docs/index.md @@ -0,0 +1 @@ +## hello doc moc diff --git a/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml new file mode 100644 index 0000000000..4fb78a8aa1 --- /dev/null +++ b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: 'moc-doc' + +nav: + - Home: index.md From f7771e0fd4b36bb6ebc4267311315f21fac884d5 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 11:28:26 +0200 Subject: [PATCH 2/5] docs(techdocs): update readme with link to mkdocs readme --- plugins/techdocs/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/plugins/techdocs/README.md b/plugins/techdocs/README.md index f25ffda3b2..10ddcf9411 100644 --- a/plugins/techdocs/README.md +++ b/plugins/techdocs/README.md @@ -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). From 062b214e0669d987e6e8b099cf8322b0a0a428b4 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 11:29:05 +0200 Subject: [PATCH 3/5] docs(mkdocs): add readme --- plugins/techdocs/mkdocs/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 plugins/techdocs/mkdocs/README.md diff --git a/plugins/techdocs/mkdocs/README.md b/plugins/techdocs/mkdocs/README.md new file mode 100644 index 0000000000..5126548f54 --- /dev/null +++ b/plugins/techdocs/mkdocs/README.md @@ -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 +``` From a8c3c0ff7850b626c8ac2ed030d46a9992994d7d Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 11:31:53 +0200 Subject: [PATCH 4/5] fix(mkdocs): update site name --- plugins/techdocs/mkdocs/mock-docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml index 4fb78a8aa1..c8370ae3ac 100644 --- a/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml +++ b/plugins/techdocs/mkdocs/mock-docs/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: 'moc-doc' +site_name: 'mock-docs' nav: - Home: index.md From eec111e210251e4518b4bfdc02fda718c35aa81f Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Tue, 23 Jun 2020 11:32:22 +0200 Subject: [PATCH 5/5] fix(mkdocs): update index.md --- plugins/techdocs/mkdocs/mock-docs/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/techdocs/mkdocs/mock-docs/docs/index.md b/plugins/techdocs/mkdocs/mock-docs/docs/index.md index 1da6f7d43e..bc437e6180 100644 --- a/plugins/techdocs/mkdocs/mock-docs/docs/index.md +++ b/plugins/techdocs/mkdocs/mock-docs/docs/index.md @@ -1 +1 @@ -## hello doc moc +## hello mock docs