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

Merge pull request #2762 from spotify/orkohunter/techdocs-container-versioning

Browse Source 
TechDocs: Document how techdocs-container image is published to DockerHub
This commit is contained in:
Himanshu Mishra
2020-10-05 23:04:53 +02:00
committed by GitHub
parent da03842a42 00342b7ab4
commit 4fce90b696
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/techdocs-container/README.md
+10
View File
@@ -19,3 +19,13 @@ docker run -w /content -v $(pwd)/mock-docs:/content -p 8000:8000 -it mkdocs:loca
```
Then open up `http://localhost:8000` on your local machine.
## Publishing
This container is published on DockerHub - https://hub.docker.com/r/spotify/techdocs
The publishing is configured by [Automated Builds](https://hub.docker.com/repository/docker/spotify/techdocs/builds/edit) feature on Docker Hub which is triggered from GitHub (on new commits and releases). @spotify/techdocs-core team has access to the settings.
The `latest` tag on Docker Hub points to the recent commits in the `master` branch. The [version tags](https://hub.docker.com/r/spotify/techdocs/tags) (e.g. v0.1.1-alpha.24) point to the GitHub tags created from [releases](https://github.com/spotify/backstage/releases) of this GitHub repository.
Note: We recommend using a specific version of the container instead of `latest` release for stability and avoiding unexpected changes.