mirror of
https://github.com/docker/docs.git
synced 2026-11-05 00:14:17 +03:00
e8181394b7
making small edits for storage doc adding a directory and editing the conf storage file need to save here, so i can fix image files renamed assets to images changing names in files from to point from assets to images. moving graphic files more graphic fixes applied current standards to screenshots fixing 404's pertaining to pointers to config file adding config files adding config files2 adding config-overview.md so it shows in left menu adding creating admin steps and screenshot fixing order in menu splitting out config files, this might get messy found lost gc graphics added to gitignore added directory to gitignore more edits fixed links added AWS policy info to config-storage.md adding new screenshots edits for release revised based on comments and added section on YAML since UI is not clear added SUSE support to install-dtr.md added two parameters and user set section added diagram for scope one level tightened language in storage doc removed placeholder edits based on feedback Signed-off-by: Carol Fager-Higgins <carol.fager-higgins@docker.com>
70 lines
2.8 KiB
Makefile
70 lines
2.8 KiB
Makefile
.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
|
|
|
|
# to allow `make DOCSDIR=docs docs-shell` (to create a bind mount in docs)
|
|
DOCS_MOUNT := $(if $(DOCSDIR),-v $(CURDIR)/$(DOCSDIR):/$(DOCSDIR))
|
|
|
|
# to allow `make DOCSPORT=9000 docs`
|
|
DOCSPORT := 8000
|
|
|
|
# Get the IP ADDRESS
|
|
DOCKER_IP=$(shell python -c "import urlparse ; print urlparse.urlparse('$(DOCKER_HOST)').hostname or ''")
|
|
HUGO_BASE_URL=$(shell test -z "$(DOCKER_IP)" && echo localhost || echo "$(DOCKER_IP)")
|
|
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))
|
|
|
|
|
|
DOCKER_RUN_DOCS := docker run --rm -it $(DOCS_MOUNT) -e AWS_S3_BUCKET -e NOCACHE
|
|
|
|
# for some docs workarounds (see below in "docs-build" target)
|
|
GITCOMMIT := $(shell git rev-parse --short HEAD 2>/dev/null)
|
|
|
|
default: docs
|
|
|
|
test: docs-build
|
|
$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 \
|
|
-v $(CURDIR):/docs/content/docker-trusted-registry/ \
|
|
-e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" \
|
|
hugo server \
|
|
--log=true --watch=true \
|
|
--port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)
|
|
|
|
docs: docs-build
|
|
$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)
|
|
|
|
docs-draft: docs-build
|
|
$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 -e DOCKERHOST "$(DOCKER_DOCS_IMAGE)" hugo server --buildDrafts="true" --port=$(DOCSPORT) --baseUrl=$(HUGO_BASE_URL) --bind=$(HUGO_BIND_IP)
|
|
|
|
|
|
docs-shell: docs-build
|
|
$(DOCKER_RUN_DOCS) -p $(if $(DOCSPORT),$(DOCSPORT):)8000 "$(DOCKER_DOCS_IMAGE)" bash
|
|
|
|
|
|
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
|
|
# bring the generated apidocs into the context.
|
|
rm -rf ./apidocgen/
|
|
cp -r ../apidocgen/output apidocgen
|
|
docker build -t "$(DOCKER_DOCS_IMAGE)" .
|
|
|
|
images:
|
|
$(MAKE) -C images
|