diff --git a/docs/Makefile b/docs/Makefile index fd0a87c3fae..645a29db7db 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,24 +1,27 @@ -.PHONY: docs docs-no-pull docs-test docs-local-static +.PHONY: pull docs docs-quick docs-no-pull docs-test docs-local-static IMAGE = grafana/grafana-docs-dev:latest CONTENT_PATH = /hugo/content/docs/grafana/latest LOCAL_STATIC_PATH = ../../website/static PORT = 3002:3002 -docs: +pull: docker pull $(IMAGE) + +docs: pull docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) +docs-quick: pull + docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) /bin/bash -c "ln -s /frontend-docs/packages_api /hugo/content/docs/grafana/latest/packages_api && hugo server -p 3002 -D --bind 0.0.0.0 --environment=quick" + docs-no-pull: docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) -docs-test: - docker pull $(IMAGE) +docs-test: pull docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z --rm -it $(IMAGE) /bin/bash -c 'make prod' # expects that you have grafana/website checked out in same path as the grafana repo. -docs-local-static: - docker pull $(IMAGE) +docs-local-static: pull if [ ! -d "$(LOCAL_STATIC_PATH)" ]; then echo "local path (website project) $(LOCAL_STATIC_PATH) not found"]; exit 1; fi docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z \ -v $(shell pwd)/$(LOCAL_STATIC_PATH):/hugo/static:Z -p $(PORT) --rm -it $(IMAGE) diff --git a/docs/README.md b/docs/README.md index 5a52d56da4e..70dc30d567a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,7 +10,7 @@ Yarn >= 1.22.4 ## Build the doc site 1. On the command line, first change to the docs folder: `cd docs`. -1. Run `make docs`. This launches a preview of the docs website at `http://localhost:3002/docs/grafana/latest/` which will refresh automatically when changes are made to content in the `sources` directory. +1. Run `make docs-quick`. This launches a preview of the website with the current grafana docs at `http://localhost:3002/docs/grafana/latest/` which will refresh automatically when changes are made to content in the `sources` directory. If you have the grafana/website repo checked out in the same directory as the grafana repo, then you can run `make docs-local-static` to use local assets (such as images).