centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-31 16:28:59 +07:00
Code Issues Packages Projects Releases Wiki Activity

fix urls found by linkchecker, and clean up tooling

Browse Source 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit
2016-05-27 18:49:38 +00:00
parent d5bba27419
commit 8fcc4a3fa0
5 changed files with 13 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Dockerfile
View File

@@ -1,5 +1,5 @@
FROM docs/base:oss
MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl)
MAINTAINER Docker Docs <docs@docker.com>
ENV PROJECT=opensource

27
docs/Makefile
View File

@@ -1,17 +1,4 @@
.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate
# env vars passed through directly to Docker's build scripts
# to allow things like `make DOCKER_CLIENTONLY=1 binary` easily
# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these
DOCKER_ENVS := \
-e BUILDFLAGS \
-e DOCKER_CLIENTONLY \
-e DOCKER_EXECDRIVER \
-e DOCKER_GRAPHDRIVER \
-e TESTDIRS \
-e TESTFLAGS \
-e TIMEOUT
# note: we _cannot_ add "-e DOCKER_BUILDTAGS" here because even if it's unset in the shell, that would shadow the "ENV DOCKER_BUILDTAGS" set in our Dockerfile, which is very important for our official builds
.PHONY: all build default docs docs-build docs-shell shell test
# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs)
DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))
@@ -25,9 +12,8 @@ HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER
HUGO_BIND_IP=0.0.0.0
GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH))
DOCKER_DOCS_IMAGE := docs-base$(if $(GIT_BRANCH),:$(GIT_BRANCH))
GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g")
DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))
DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE
@@ -48,8 +34,7 @@ docs-shell: docs-build
docs-build:
# ( git remote | grep -v upstream ) || git diff --name-status upstream/release..upstream/docs ./ > ./changed-files
# echo "$(GIT_BRANCH)" > GIT_BRANCH
# echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET
# echo "$(GITCOMMIT)" > GITCOMMIT
docker build -t "$(DOCKER_DOCS_IMAGE)" .
test: docs-build
$(DOCKER_RUN_DOCS) -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)"

5
docs/get-help.md
View File

@@ -190,9 +190,8 @@ on the command line using this command:
/msg NickServ identify <password>
With Webchat if you forget or lose your password see <a
href="https://freenode.net/faq.shtml#sendpass" target="_blank">the FAQ on
freenode.net</a> to learn how to recover it.
With Webchat if you forget or lose your password you'll need to join the
`#freenode` channel and request them to reset it for you.
### Join a Docker Channel

6
docs/ways/community.md
View File

@@ -20,7 +20,7 @@ contribute mentoring if you have good knowledge of:
* using Git, Go, GitHub, IRC, or other common tools
Also, choose mentoring if you like to be happy. Studies show that <a
href="http://goo.gl/HSz8UT" target="_blank">helping others</a> is a great way to
href="http://www.huffingtonpost.com/2013/09/03/five-minute-favor-adam-rifkin_n_3805090.html" target="_blank">helping others</a> is a great way to
boost your own well being.
@@ -34,8 +34,8 @@ target="_blank">Docker Community Forum</a>
* <a href="http://stackoverflow.com/search?tab=newest&q=docker"
target="_blank">StackOverflow</a>
You can also check the <a href="http://goo.gl/Kv8EdU" target="_blank">list of
open user questions</a> on the Docker Engine project.
You can also check the <a href="https://github.com/docker/docker/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fquestion+-label%3Astatus%2Fclaimed+-label%3Astatus%2Fassigned+no%3Aassignee" target="_blank">list of
open user questions</a> on the Docker project.
## Docker contributors

2
docs/workflow/coding-style.md
View File

@@ -52,7 +52,7 @@ program code and documentation code.
* Use existing Docker test files (`name_test.go`) for inspiration.
* Run <a href="../../project/test-and-docs/" target="_blank">the full test suite</a> on your
* Run [the full test suite](../project/test-and-docs.md) on your
branch before submitting a pull request.
* Run `make docs` to build the documentation and then check it locally.