paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

Merge pull request #1596 from spotify/mob/update-techdocs-container

Browse Source 
TechDocs: updated techdocs container docs
This commit is contained in:
ellieseastream
2020-07-13 15:13:59 +02:00
committed by GitHub
parent 55df832891 329305087c
commit 471b9faccd
2 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CODEOWNERS
+5 -3
View File
@@ -4,6 +4,8 @@
# The last matching pattern takes precedence.
# https://help.github.com/articles/about-codeowners/
* @spotify/backstage-core
/plugins/techdocs @spotify/techdocs-core
/packages/techdocs-cli @spotify/techdocs-core
* @spotify/backstage-core
/plugins/techdocs @spotify/techdocs-core
/plugins/techdocs-backend @spotify/techdocs-core
/packages/techdocs-cli @spotify/techdocs-core
/packages/techdocs-container @spotify/techdocs-core
packages/techdocs-container/README.md
+3 -3
View File
@@ -9,15 +9,15 @@ This is the Docker container that powers the creation of static documentation si
Using the TechDocs CLI, we can invoke the latest version of `techdocs-container` via Docker Hub:
```bash
npx @techdocs/cli serve:container
npx @techdocs/cli serve
```
## Local Development
```bash
docker build ./container -t techdocs-container
docker build . -t mkdocs:local-dev
docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it techdocs-container serve -a 0.0.0.0:8000
docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs:local-dev serve -a 0.0.0.0:8000
```
Then open up `http://localhost:8000` on your local machine.