docs/Makefile

.PHONY: pull docs docs-quick docs-no-pull docs-test docs-local-static

PODMAN = $(shell if command -v podman >/dev/null 2>&1; then echo podman; else echo docker; fi)
IMAGE = grafana/docs-base:latest
CONTENT_PATH = /hugo/content/docs/grafana/latest
LOCAL_STATIC_PATH = ../../website/static
PORT = 3002:3002

pull:
	$(PODMAN) pull $(IMAGE)

docs: pull
	$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) make server

docs-preview: pull
	$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) make server BUILD_DRAFTS=true

docs-no-pull:
	$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) make server

docs-test: pull
	$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z --rm -it $(IMAGE) make prod

# expects that you have grafana/website checked out in same path as the grafana repo.
docs-local-static: pull
	if [ ! -d "$(LOCAL_STATIC_PATH)" ]; then echo "local path (website project) $(LOCAL_STATIC_PATH) not found"]; exit 1; fi
	$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z \
		-v $(shell pwd)/$(LOCAL_STATIC_PATH):/hugo/static:Z -p $(PORT) --rm -it $(IMAGE)
docs: add quick build (#31663 ) 2021-03-12 14:53:17 +01:00			`.PHONY: pull docs docs-quick docs-no-pull docs-test docs-local-static`
docs: always updates docker image before building docs site (#21165 ) 2019-12-18 13:26:47 +01:00
Use more portable output redirection (#62686 ) 2023-02-07 15:10:16 +00:00			`PODMAN = $(shell if command -v podman >/dev/null 2>&1; then echo podman; else echo docker; fi)`
update docs docker image reference (#61269 ) 2023-01-13 17:19:23 +01:00			`IMAGE = grafana/docs-base:latest`
Replace ambiguous relrefs with partial URIs to prevent 404s (#62468 ) 2023-01-30 12:48:12 +00:00			`CONTENT_PATH = /hugo/content/docs/grafana/latest`
Docs: include Makefile option for local assets (#30455 ) 2021-01-21 07:27:54 -05:00			`LOCAL_STATIC_PATH = ../../website/static`
docs: use selinux relabelling on docker containers (#27685 ) 2021-02-04 12:54:48 -05:00			`PORT = 3002:3002`
Docs: add test for website build (#21364 ) 2020-01-14 16:26:00 +01:00
docs: add quick build (#31663 ) 2021-03-12 14:53:17 +01:00			`pull:`
Codegen: Generate per-kind reference docs (#60416 ) 2023-01-16 13:55:40 +01:00			`$(PODMAN) pull $(IMAGE)`
docs: add quick build (#31663 ) 2021-03-12 14:53:17 +01:00
			`docs: pull`
Add --init to all podman invocations to ensure ^C works on MacOS (#61745 ) 2023-02-22 10:54:35 +00:00			`$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) make server`
Codegen: Generate per-kind reference docs (#60416 ) 2023-01-16 13:55:40 +01:00
			`docs-preview: pull`
Add --init to all podman invocations to ensure ^C works on MacOS (#61745 ) 2023-02-22 10:54:35 +00:00			`$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) make server BUILD_DRAFTS=true`
Codegen: Generate per-kind reference docs (#60416 ) 2023-01-16 13:55:40 +01:00
Build: changing docs docker image to prevent setting up frontend devenv. (#28670 ) 2020-10-30 10:22:01 +01:00			`docs-no-pull:`
Add --init to all podman invocations to ensure ^C works on MacOS (#61745 ) 2023-02-22 10:54:35 +00:00			`$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) make server`
Docs: updated cmd to build docs locally to generate docs prior to building site. (#28371 ) 2020-10-22 09:57:56 +02:00
docs: add quick build (#31663 ) 2021-03-12 14:53:17 +01:00			`docs-test: pull`
Add --init to all podman invocations to ensure ^C works on MacOS (#61745 ) 2023-02-22 10:54:35 +00:00			`$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z --rm -it $(IMAGE) make prod`
Docs: include Makefile option for local assets (#30455 ) 2021-01-21 07:27:54 -05:00
			`# expects that you have grafana/website checked out in same path as the grafana repo.`
docs: add quick build (#31663 ) 2021-03-12 14:53:17 +01:00			`docs-local-static: pull`
Docs: include Makefile option for local assets (#30455 ) 2021-01-21 07:27:54 -05:00			`if [ ! -d "$(LOCAL_STATIC_PATH)" ]; then echo "local path (website project) $(LOCAL_STATIC_PATH) not found"]; exit 1; fi`
Add --init to all podman invocations to ensure ^C works on MacOS (#61745 ) 2023-02-22 10:54:35 +00:00			`$(PODMAN) run --init -v $(shell pwd)/sources:$(CONTENT_PATH):Z \`
docs: use selinux relabelling on docker containers (#27685 ) 2021-02-04 12:54:48 -05:00			`-v $(shell pwd)/$(LOCAL_STATIC_PATH):/hugo/static:Z -p $(PORT) --rm -it $(IMAGE)`