forklift-documentation/Makefile at main · kubev2v/forklift-documentation · 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
ASCIIDOCTOR ?= asciidoctor
OUTDIR      := _site
DOCDIR      := documentation

CONTAINER_ENGINE ?= $(shell command -v podman 2>/dev/null || command -v docker 2>/dev/null)
IMAGE_NAME       := forklift-docs-builder

ATTRS := -a upstream -a build=upstream -a docinfodir=$(CURDIR)/$(DOCDIR) -a docinfo=shared

GUIDES := $(DOCDIR)/doc-Planning_your_migration/master.adoc \
          $(DOCDIR)/doc-Migrating_your_virtual_machines/master.adoc \
          $(DOCDIR)/doc-Release_notes/master.adoc

HTML_OUT := $(patsubst $(DOCDIR)/%.adoc,$(OUTDIR)/$(DOCDIR)/%.html,$(GUIDES))

.DEFAULT_GOAL := help
.PHONY: help build serve build-local serve-local image clean search copy-assets

## help: Show this help message
help:
	@printf '\nUsage: make \033[36m<target>\033[0m\n\n'
	@awk '/^## /{desc=$$0; sub(/^## [a-zA-Z_-]+: /,"",desc)} /^[a-zA-Z_-]+:/{if(desc){printf "  \033[36m%-15s\033[0m %s\n",$$1,desc; desc=""}}' $(MAKEFILE_LIST)
	@echo

# --- Container targets (recommended) ---

## image: Build the container image
image:
	$(CONTAINER_ENGINE) build -t $(IMAGE_NAME) .

## build: Build docs in a container (recommended)
build: image
	$(CONTAINER_ENGINE) run --rm -v $(CURDIR):/docs:Z $(IMAGE_NAME) make build-local

## serve: Build and serve docs in a container at localhost:8000
serve: image
	$(CONTAINER_ENGINE) run --rm -v $(CURDIR):/docs:Z -p 8000:8000 $(IMAGE_NAME) make serve-local

# --- Local targets (require Ruby, Asciidoctor, Node.js, Python 3) ---

## build-local: Build docs locally (requires Ruby, Asciidoctor, Node.js)
build-local: $(HTML_OUT) copy-assets search

$(OUTDIR)/$(DOCDIR)/%.html: $(DOCDIR)/%.adoc
	@mkdir -p $(dir $@)
	$(ASCIIDOCTOR) -b html5 -d book --safe-mode unsafe $(ATTRS) -o $(CURDIR)/$@ $<

## copy-assets: Copy static assets to the output directory
copy-assets:
	@mkdir -p $(OUTDIR)/$(DOCDIR)
	cp $(DOCDIR)/index.html $(OUTDIR)/$(DOCDIR)/index.html
	@mkdir -p $(OUTDIR)/assets/img
	cp -r assets/img/* $(OUTDIR)/assets/img/ 2>/dev/null || true
	@echo '<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0;url=documentation/index.html"></head></html>' > $(OUTDIR)/index.html

## search: Generate the Pagefind search index
search:
	npx -y pagefind --site $(OUTDIR) --root-selector "#content" --output-subdir _pagefind

## serve-local: Build and serve docs locally at localhost:8000
serve-local: build-local
	@echo "Serving at http://localhost:8000"
	@cd $(OUTDIR) && python3 -m http.server 8000

## clean: Remove the build output directory
clean:
	rm -rf $(OUTDIR)