backport of commit 88e93ce

hashicorp · Apr 5, 2022 · 4c2b473 · 4c2b473
1 parent 8663961
commit 4c2b473
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/website/Makefile b/website/Makefile
@@ -15,20 +15,24 @@ DOCKER_RUN_FLAGS=-it \
 		--volume "$(PWD)/.env:/app/.env" \
 		-e "REPO=vault"
 
+# Default: run this if working on the website locally to run in watch mode.
 .PHONY: website
 website:
 	@echo "==> Downloading latest Docker image..."
 	@docker pull $(DOCKER_IMAGE)
 	@echo "==> Starting website..."
 	@docker run $(DOCKER_RUN_FLAGS) $(DOCKER_IMAGE)
 
+# Use this if you have run `website/build-local` to use the locally built image.
 .PHONY: website/local
 website/local:
 	@echo "==> Starting website from local image..."
 	@docker run $(DOCKER_RUN_FLAGS) $(DOCKER_IMAGE_LOCAL)
 
+# Run this to generate a new local Docker image.
 .PHONY: website/build-local
 website/build-local:
 	@echo "==> Building local Docker image"
 	@docker build https://github.com/hashicorp/dev-portal.git\#main \
 		-t $(DOCKER_IMAGE_LOCAL)
+