mirror of https://github.com/docker/docs.git
This is needed for the following reasons: 1. gh-pages >= 174 is required to fix the issue #4178 [1] 2. Not using a tag leads to pulling some unknown version of the image, which might or might not work. 3. Not using a tag means the image is never rebuilt. NOTE: it was not possible to use a tag before, as recent gh-pages releases were not tagged on dockerhub; this is now fixed (see https://github.com/Starefossen/docker-github-pages/issues/36). [1] https://github.com/docker/docker.github.io/issues/4178 Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> |
||
---|---|---|
.gitignore | ||
Dockerfile | ||
README.md | ||
index.html | ||
nginx.conf |
README.md
docs-base
This is the source for docs/docker.github.io:docs-base.
The docs-base Dockerfile includes:
- The GitHub Pages environment (w/Jekyll)
- nginx
- Builds of all previous versions of Docker's documentation
Having this large amount of stuff that stays relatively static in a base image helps keep build times for the docs low as we can use Docker Cloud's caching when running auto-builds out of GitHub.
While you would only see the docs archives by doing so, you can run docs-base locally and peruse by running:
docker run -ti -p 4000:4000 docs/docker.github.io:docs-base
The contents of docs-base will then be viewable in your browser at
localhost:4000
.
Reasons to update this branch
- Changing the nginx configuration
- Publishing a new docs archive, or anything else that stays static between doc builds.
- Updating the GitHub Pages version used in production to a newer release