From 8fcc4a3fa0bade76351fbdd69dc47c6bcf97cc2e Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Fri, 27 May 2016 18:49:38 +0000 Subject: [PATCH] fix urls found by linkchecker, and clean up tooling Signed-off-by: Sven Dowideit --- docs/Dockerfile | 2 +- docs/Makefile | 27 ++++++--------------------- docs/get-help.md | 5 ++--- docs/ways/community.md | 6 +++--- docs/workflow/coding-style.md | 2 +- 5 files changed, 13 insertions(+), 29 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index 5e66615274..fff39f3314 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,5 +1,5 @@ FROM docs/base:oss -MAINTAINER Mary Anthony (@moxiegirl) +MAINTAINER Docker Docs ENV PROJECT=opensource diff --git a/docs/Makefile b/docs/Makefile index 021e8f6e5e..56916a1582 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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)" diff --git a/docs/get-help.md b/docs/get-help.md index 19a587a6bf..09fc5e1320 100644 --- a/docs/get-help.md +++ b/docs/get-help.md @@ -190,9 +190,8 @@ on the command line using this command: /msg NickServ identify -With Webchat if you forget or lose your password see the FAQ on -freenode.net 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 diff --git a/docs/ways/community.md b/docs/ways/community.md index deb21c99f4..be042327e5 100644 --- a/docs/ways/community.md +++ b/docs/ways/community.md @@ -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 helping others 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 is a great way to boost your own well being. @@ -34,8 +34,8 @@ target="_blank">Docker Community Forum * StackOverflow -You can also check the list of -open user questions on the Docker Engine project. +You can also check the list of +open user questions on the Docker project. ## Docker contributors diff --git a/docs/workflow/coding-style.md b/docs/workflow/coding-style.md index fbb3b1de4a..8440321354 100644 --- a/docs/workflow/coding-style.md +++ b/docs/workflow/coding-style.md @@ -52,7 +52,7 @@ program code and documentation code. * Use existing Docker test files (`name_test.go`) for inspiration. -* Run the full test suite 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.