diff --git a/Makefile b/Makefile index 65ae40fff..09583851b 100644 --- a/Makefile +++ b/Makefile @@ -190,11 +190,17 @@ crds: $(CONTROLLER_GEN) $(YQ) @echo Updating CRD manifests @build/crds/build-crds.sh $(CONTROLLER_GEN) $(YQ) -gen-rbac: $(HELM) $(YQ) ## generate RBAC from Helm charts +gen-rbac: $(HELM) $(YQ) ## Generate RBAC from Helm charts @# output only stdout to the file; stderr for debugging should keep going to stderr HELM=$(HELM) ./build/rbac/gen-common.sh HELM=$(HELM) ./build/rbac/gen-nfs-rbac.sh +docs-preview: ## Preview the documentation through mkdocs + mkdocs serve + +docs-build: ## Build the documentation to the `site/` directory + mkdocs build --strict + .PHONY: all build.common .PHONY: build build.all install test check vet fmt codegen mod.check clean distclean prune diff --git a/build/release/Makefile b/build/release/Makefile index 50b370414..bbd4eb296 100644 --- a/build/release/Makefile +++ b/build/release/Makefile @@ -131,9 +131,14 @@ endif # ==================================================================================== # docs -build.docs: + +deps.docs: pip3 install -r requirements_docs.txt +build.docs: deps.docs + # Build the docs once before they are published to ensure they are correctly building + mkdocs build --strict + publish.docs: if ! git remote show docs > /dev/null 2>&1; then git remote add docs $(DOCS_GIT_REPO); fi # If we are running in GitHub actions, remove the extraheader so our custom GitHub API token is used