metal3-docs/Makefile at main · metal3-io/metal3-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
MDBOOK_BIN_VERSION ?= v0.4.52
SOURCE_PATH := docs/user-guide
CONTAINER_RUNTIME ?= docker
IMAGE_NAME := quay.io/metal3-io/mdbook
IMAGE_TAG ?= latest
HOST_PORT ?= 3000
MDBOOK_RELEASE_URL := https://github.com/rust-lang/mdBook/releases/download/$(MDBOOK_BIN_VERSION)/mdbook-$(MDBOOK_BIN_VERSION)-x86_64-unknown-linux-gnu.tar.gz
TOOLS_DIR := hack/tools
TOOLS_BIN_DIR := $(abspath $(TOOLS_DIR)/bin)
MDBOOK_BIN := $(TOOLS_BIN_DIR)/mdbook

export PATH := $(PATH):$(TOOLS_BIN_DIR)

## ------------------------------------
## mdbook plugins
## ------------------------------------
RELEASETAGS := $(TOOLS_BIN_DIR)/mdbook-releasetags
$(RELEASETAGS): $(TOOLS_DIR)/go.mod
	cd $(TOOLS_DIR); go build -tags=tools -o $(TOOLS_BIN_DIR)/mdbook-releasetags ./releasetags

MDBOOK_EMBED := $(TOOLS_BIN_DIR)/mdbook-embed
$(MDBOOK_EMBED): $(TOOLS_DIR)/go.mod
	cd $(TOOLS_DIR); go build -tags=tools -o $(TOOLS_BIN_DIR)/mdbook-embed sigs.k8s.io/cluster-api/hack/tools/mdbook/embed

## ------------------------------------
## Documentation tooling for Netlify
## ------------------------------------

# This binary is used by Netlify. Because,
# Netlify build image doesn't support docker/podman.

$(MDBOOK_BIN): # Download the binary
	curl -L $(MDBOOK_RELEASE_URL) | tar xvz -C $(TOOLS_BIN_DIR)

.PHONY: netlify-build
netlify-build: $(MDBOOK_EMBED) $(RELEASETAGS) $(MDBOOK_BIN)
	$(MDBOOK_BIN) build $(SOURCE_PATH)


## ------------------------------------
## Documentation tooling for local dev
## ------------------------------------

.PHONY: build
docker-build: # Build the mdbook container image
	$(CONTAINER_RUNTIME) build --build-arg MDBOOK_RELEASE_URL=$(MDBOOK_RELEASE_URL) \
	--tag $(IMAGE_NAME):$(IMAGE_TAG) -f docs/Dockerfile .

.PHONY: build
build:# Build the user guide
	$(CONTAINER_RUNTIME) run \
	--rm -it --name metal3 \
	--user $$(id -u):$$(id -g) \
	-v "$$(pwd):/workdir" \
	$(IMAGE_NAME):$(IMAGE_TAG) \
	mdbook build $(SOURCE_PATH)

.PHONY: serve
serve:# Serve the user-guide on localhost:3000 (by default)
	$(CONTAINER_RUNTIME) run \
	--rm -it --init --name metal3 \
	--user $$(id -u):$$(id -g) \
	-v "$$(pwd):/workdir" \
	-p $(HOST_PORT):3000 \
	$(IMAGE_NAME):$(IMAGE_TAG) \
	mdbook serve --open $(SOURCE_PATH) -p 3000 -n 0.0.0.0

.PHONY: clean
clean: # Clean mdbook generated content
	$(CONTAINER_RUNTIME) run \
	--rm -it --name metal3 \
	-v "$$(pwd):/workdir" \
	$(IMAGE_NAME):$(IMAGE_TAG) \
	mdbook clean $(SOURCE_PATH)

## ------------------------------------
## Linting and testing
## ------------------------------------

.PHONY: lint
lint: markdownlint spellcheck shellcheck # Run all linting tools

.PHONY: markdownlint
markdownlint: # Run markdownlint
	./hack/markdownlint.sh

.PHONY: spellcheck
spellcheck: # Run spellcheck
	./hack/spellcheck.sh

.PHONY: shellcheck
shellcheck: # Run shellcheck
	./hack/shellcheck.sh