mirror of
https://github.com/grafana/grafana.git
synced 2024-11-29 20:24:18 -06:00
a4a16b62c7
## 4.1.0 (2023-06-16) ### Added - Mounts of `layouts` and `config` directories for the `website` project. Ensures that local changes to mounts or shortcodes are reflected in the development server. ### Fixed - Version inference for versioned docs pages. Pages in versioned projects now have the `versioned: true` front matter set to ensure that "version" in $.Page.Scratch is set on builds. ## 4.0.0 (2023-06-06) ### Removed - `doc-validator/%` target. The behavior of the target was not as described. Instead, to limit `doc-validator` to only specific files, refer to https://grafana.com/docs/writers-toolkit/writing-guide/tooling-and-workflows/validate-technical-documentation/#run-on-specific-files. ## 3.0.0 (2023-05-18) ### Fixed - Compatibility with the updated Make targets in the `website` repository. `docs` now runs this script itself, `server-docs` builds the site with the `docs` Hugo environment. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
118 lines
3.8 KiB
Makefile
118 lines
3.8 KiB
Makefile
# The source of this file is https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk.
|
|
# 4.0.0 (2023-06-06)
|
|
include variables.mk
|
|
-include variables.mk.local
|
|
|
|
.ONESHELL:
|
|
.DELETE_ON_ERROR:
|
|
export SHELL := bash
|
|
export SHELLOPTS := pipefail:errexit
|
|
MAKEFLAGS += --warn-undefined-variables
|
|
MAKEFLAGS += --no-builtin-rule
|
|
|
|
.DEFAULT_GOAL: help
|
|
|
|
# Adapted from https://www.thapaliya.com/en/writings/well-documented-makefiles/
|
|
.PHONY: help
|
|
help: ## Display this help.
|
|
help:
|
|
@awk 'BEGIN { \
|
|
FS = ": ##"; \
|
|
printf "Usage:\n make <target>\n\nTargets:\n" \
|
|
} \
|
|
/^[a-zA-Z0-9_\.\-\/%]+: ##/ { printf " %-15s %s\n", $$1, $$2 }' \
|
|
$(MAKEFILE_LIST)
|
|
|
|
GIT_ROOT := $(shell git rev-parse --show-toplevel)
|
|
|
|
PODMAN := $(shell if command -v podman >/dev/null 2>&1; then echo podman; else echo docker; fi)
|
|
|
|
ifeq ($(PROJECTS),)
|
|
$(error "PROJECTS variable must be defined in variables.mk")
|
|
endif
|
|
|
|
# First project is considered the primary one used for doc-validator.
|
|
PRIMARY_PROJECT := $(subst /,-,$(firstword $(subst :, ,$(firstword $(PROJECTS)))))
|
|
|
|
# Name for the container.
|
|
ifeq ($(origin DOCS_CONTAINER), undefined)
|
|
export DOCS_CONTAINER := $(PRIMARY_PROJECT)-docs
|
|
endif
|
|
|
|
# Host port to publish container port to.
|
|
ifeq ($(origin DOCS_HOST_PORT), undefined)
|
|
export DOCS_HOST_PORT := 3002
|
|
endif
|
|
|
|
# Container image used to perform Hugo build.
|
|
ifeq ($(origin DOCS_IMAGE), undefined)
|
|
export DOCS_IMAGE := grafana/docs-base:latest
|
|
endif
|
|
|
|
# Container image used for doc-validator linting.
|
|
ifeq ($(origin DOC_VALIDATOR_IMAGE), undefined)
|
|
export DOC_VALIDATOR_IMAGE := grafana/doc-validator:latest
|
|
endif
|
|
|
|
# Container image used for vale linting.
|
|
ifeq ($(origin VALE_IMAGE), undefined)
|
|
export VALE_IMAGE := grafana/vale:latest
|
|
endif
|
|
|
|
# PATH-like list of directories within which to find projects.
|
|
# If all projects are checked out into the same directory, ~/repos/ for example, then the default should work.
|
|
ifeq ($(origin REPOS_PATH), undefined)
|
|
export REPOS_PATH := $(realpath $(GIT_ROOT)/..)
|
|
endif
|
|
|
|
# How to treat Hugo relref errors.
|
|
ifeq ($(origin HUGO_REFLINKSERRORLEVEL), undefined)
|
|
export HUGO_REFLINKSERRORLEVEL := WARNING
|
|
endif
|
|
|
|
.PHONY: docs-rm
|
|
docs-rm: ## Remove the docs container.
|
|
$(PODMAN) rm -f $(DOCS_CONTAINER)
|
|
|
|
.PHONY: docs-pull
|
|
docs-pull: ## Pull documentation base image.
|
|
$(PODMAN) pull $(DOCS_IMAGE)
|
|
|
|
make-docs: ## Fetch the latest make-docs script.
|
|
make-docs:
|
|
if [[ ! -f "$(PWD)/make-docs" ]]; then
|
|
echo 'WARN: No make-docs script found in the working directory. Run `make update` to download it.' >&2
|
|
exit 1
|
|
fi
|
|
|
|
.PHONY: docs
|
|
docs: ## Serve documentation locally, which includes pulling the latest `DOCS_IMAGE` (default: `grafana/docs-base:latest`) container image. See also `docs-no-pull`.
|
|
docs: docs-pull make-docs
|
|
$(PWD)/make-docs $(PROJECTS)
|
|
|
|
.PHONY: docs-no-pull
|
|
docs-no-pull: ## Serve documentation locally without pulling the `DOCS_IMAGE` (default: `grafana/docs-base:latest`) container image.
|
|
docs-no-pull: make-docs
|
|
$(PWD)/make-docs $(PROJECTS)
|
|
|
|
.PHONY: docs-debug
|
|
docs-debug: ## Run Hugo web server with debugging enabled. TODO: support all SERVER_FLAGS defined in website Makefile.
|
|
docs-debug: make-docs
|
|
WEBSITE_EXEC='hugo server --bind 0.0.0.0 --port 3002 --debug' $(PWD)/make-docs $(PROJECTS)
|
|
|
|
.PHONY: doc-validator
|
|
doc-validator: ## Run doc-validator on the entire docs folder.
|
|
doc-validator: make-docs
|
|
DOCS_IMAGE=$(DOC_VALIDATOR_IMAGE) $(PWD)/make-docs $(PROJECTS)
|
|
|
|
.PHONY: vale
|
|
vale: ## Run vale on the entire docs folder.
|
|
vale: make-docs
|
|
DOCS_IMAGE=$(VALE_IMAGE) $(PWD)/make-docs $(PROJECTS)
|
|
|
|
.PHONY: update
|
|
update: ## Fetch the latest version of this Makefile and the `make-docs` script from Writers' Toolkit.
|
|
curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk
|
|
curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs
|
|
chmod +x make-docs
|