Skip to content

Commit 8dcf736

Browse files
committed
Merge pull request #70 from SvenDowideit/url-and-tooling-fixes
fix urls found by linkchecker, and clean up tooling
2 parents d5bba27 + 8fcc4a3 commit 8dcf736

File tree

5 files changed

+13
-29
lines changed

5 files changed

+13
-29
lines changed

docs/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
FROM docs/base:oss
2-
MAINTAINER Mary Anthony <mary@docker.com> (@moxiegirl)
2+
MAINTAINER Docker Docs <docs@docker.com>
33

44
ENV PROJECT=opensource
55

docs/Makefile

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
.PHONY: all binary build cross default docs docs-build docs-shell shell test test-unit test-integration test-integration-cli test-docker-py validate
2-
3-
# env vars passed through directly to Docker's build scripts
4-
# to allow things like `make DOCKER_CLIENTONLY=1 binary` easily
5-
# `docs/sources/contributing/devenvironment.md ` and `project/PACKAGERS.md` have some limited documentation of some of these
6-
DOCKER_ENVS := \
7-
-e BUILDFLAGS \
8-
-e DOCKER_CLIENTONLY \
9-
-e DOCKER_EXECDRIVER \
10-
-e DOCKER_GRAPHDRIVER \
11-
-e TESTDIRS \
12-
-e TESTFLAGS \
13-
-e TIMEOUT
14-
# 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
1+
.PHONY: all build default docs docs-build docs-shell shell test
152

163
# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs)
174
DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))
@@ -25,9 +12,8 @@ HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER
2512
HUGO_BIND_IP=0.0.0.0
2613

2714
GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
28-
DOCKER_IMAGE := docker$(if $(GIT_BRANCH),:$(GIT_BRANCH))
29-
DOCKER_DOCS_IMAGE := docs-base$(if $(GIT_BRANCH),:$(GIT_BRANCH))
30-
15+
GIT_BRANCH_CLEAN := $(shell echo $(GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g")
16+
DOCKER_DOCS_IMAGE := docker-docs$(if $(GIT_BRANCH_CLEAN),:$(GIT_BRANCH_CLEAN))
3117

3218
DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE
3319

@@ -48,8 +34,7 @@ docs-shell: docs-build
4834

4935

5036
docs-build:
51-
# ( git remote | grep -v upstream ) || git diff --name-status upstream/release..upstream/docs ./ > ./changed-files
52-
# echo "$(GIT_BRANCH)" > GIT_BRANCH
53-
# echo "$(AWS_S3_BUCKET)" > AWS_S3_BUCKET
54-
# echo "$(GITCOMMIT)" > GITCOMMIT
5537
docker build -t "$(DOCKER_DOCS_IMAGE)" .
38+
39+
test: docs-build
40+
$(DOCKER_RUN_DOCS) -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)"

docs/get-help.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,8 @@ on the command line using this command:
190190

191191
/msg NickServ identify <password>
192192

193-
With Webchat if you forget or lose your password see <a
194-
href="https://freenode.net/faq.shtml#sendpass" target="_blank">the FAQ on
195-
freenode.net</a> to learn how to recover it.
193+
With Webchat if you forget or lose your password you'll need to join the
194+
`#freenode` channel and request them to reset it for you.
196195

197196
### Join a Docker Channel
198197

docs/ways/community.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ contribute mentoring if you have good knowledge of:
2020
* using Git, Go, GitHub, IRC, or other common tools
2121

2222
Also, choose mentoring if you like to be happy. Studies show that <a
23-
href="http://goo.gl/HSz8UT" target="_blank">helping others</a> is a great way to
23+
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
2424
boost your own well being.
2525

2626

@@ -34,8 +34,8 @@ target="_blank">Docker Community Forum</a>
3434
* <a href="http://stackoverflow.com/search?tab=newest&q=docker"
3535
target="_blank">StackOverflow</a>
3636

37-
You can also check the <a href="http://goo.gl/Kv8EdU" target="_blank">list of
38-
open user questions</a> on the Docker Engine project.
37+
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
38+
open user questions</a> on the Docker project.
3939

4040

4141
## Docker contributors

docs/workflow/coding-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ program code and documentation code.
5252

5353
* Use existing Docker test files (`name_test.go`) for inspiration.
5454

55-
* Run <a href="../../project/test-and-docs/" target="_blank">the full test suite</a> on your
55+
* Run [the full test suite](../project/test-and-docs.md) on your
5656
branch before submitting a pull request.
5757

5858
* Run `make docs` to build the documentation and then check it locally.

0 commit comments

Comments
 (0)