mirror of
https://github.com/grafana/grafana.git
synced 2024-11-29 12:14:08 -06:00
68e38aad6a
* Use one sentence per line for better line based diffing Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add missing and required description front matter Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix heading hierarchy Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix doc-validator linting errors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add doc-validator make target Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix nested lists Signed-off-by: Jack Baldry <jack.baldry@grafana.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
34 lines
1.5 KiB
Makefile
34 lines
1.5 KiB
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)
|
|
|
|
.PHONY: doc-validator/%
|
|
doc-validator/%: ## Run doc-validator on a specific path. To lint the path /docs/sources/administration, run 'make doc-validator/administration'.
|
|
doc-validator/%:
|
|
$(PODMAN) run --init -v "$(shell pwd)/sources:/sources" grafana/doc-validator:latest --skip-image-validation --include=$(subst doc-validator/,,$@) ./sources /docs/grafana/latest
|