From 984b1a04314babdcf23d4b27bb8c0d86c2765417 Mon Sep 17 00:00:00 2001 From: Randall Morey Date: Fri, 9 Oct 2020 16:18:58 -0400 Subject: [PATCH] docs: add UI troubleshooting blurbs (#598) --- README.md | 5 +++++ website/content/docs/developing/building.mdx | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index b86df08ec..b95e32cd7 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,11 @@ variable. For example: will update your local UI assets. +#### UI Build Troubleshooting + +UI assets are built within a Docker container. If you encounter issues with +this build step, trying increasing memory and swap available to Docker. + #### UI Development It would be impractical to rebuild the binary on every change when actively diff --git a/website/content/docs/developing/building.mdx b/website/content/docs/developing/building.mdx index 9f8f9791e..5d103d2d0 100644 --- a/website/content/docs/developing/building.mdx +++ b/website/content/docs/developing/building.mdx @@ -28,3 +28,8 @@ If you need to cross compile boundary for another OS or architecture, use the [X environment variable to set this. Example: `$ XC_OSARCH=linux/amd64 make dev` For more details, please consult the [Boundary project on GitHub](https://github.com/hashicorp/boundary#build-and-start-boundary-in-dev-mode). + +## Troubleshooting + +UI assets are built inside a Docker container. If this build step fails, try +increasing memory and swap available to Docker.