hashicorp/dev-portal repository overview

⁠HashiCorp Product Documentation Sites

This Docker image is built to locally run HashiCorp's product documentation sites. This image exposes a Next.js⁠ application running in development mode. This image is not intended to be used on its own, but is provided so that contributors to our products can run the documentation sites locally.

⁠Usage

Usage is dependent on the product repository you are working in. In the /website directory of a HashiCorp product repository, running make will start the website using this docker image. For example, here is the docker run command used for Waypoint:

docker run -it \
		--publish "3000:3000" \
		--rm \
		--tty \
		--volume "$(pwd)/content:/app/content" \
		--volume "$(pwd)/public:/app/public" \
		--volume "$(pwd)/data:/app/data" \
		--volume "$(pwd)/redirects.js:/app/redirects.js" \
		--volume "next-dir:/app/website-preview/.next" \
		--volume "$(pwd)/.env:/app/.env" \
		-e "REPO=waypoint" \
		hashicorp/dev-portal

⁠Community

Please open any issues related to the use of this Docker image in the Dev Portal repository⁠.