From de700cea877942757d317fd6f8ba9c607e3e3426 Mon Sep 17 00:00:00 2001 From: Jeff Malnick Date: Fri, 25 Sep 2020 23:07:31 -0700 Subject: [PATCH] docs: move developing UI to developing Boundary section (#467) --- website/content/docs/developing/index.mdx | 5 +++-- website/content/docs/developing/ui.mdx | 22 +++++++++++++++++++ .../docs/getting-started/run-and-login.mdx | 14 ------------ 3 files changed, 25 insertions(+), 16 deletions(-) create mode 100644 website/content/docs/developing/ui.mdx diff --git a/website/content/docs/developing/index.mdx b/website/content/docs/developing/index.mdx index af8d14c49..0c070bc07 100644 --- a/website/content/docs/developing/index.mdx +++ b/website/content/docs/developing/index.mdx @@ -1,10 +1,11 @@ --- layout: docs -page_title: Documentation +page_title: Developing Boundary sidebar_title: Developing Boundary description: Developing Boundary --- # Developing Boundary -Please consult our [project on GitHub](https://github.com/hashicorp/boundary) for more information about contributing and developing Boundary. +The side-bar contains some common development tasks, but for the most up-to-date information about developing Boundary, please consult +our [project on GitHub](https://github.com/hashicorp/boundary) for more information. diff --git a/website/content/docs/developing/ui.mdx b/website/content/docs/developing/ui.mdx new file mode 100644 index 000000000..ee8cc97e6 --- /dev/null +++ b/website/content/docs/developing/ui.mdx @@ -0,0 +1,22 @@ +--- +layout: docs +page_title: Developing the UI +sidebar_title: Developing the UI +description: Developing the Boundary User Interface +--- + +# Developing the Boundary User Interface + +For detailed instructions and the most up-to-date information on developing the +Boundary admin UI, please consult [the project README on GitHub](https://github.com/hashicorp/boundary-ui). + +## Run a Local Fork of the UI Locally in Dev Mode + +If you're developing the Boundary UI locally you can point a dev mode server at a +local checkout of the repo without building it into the binary. We call this +directory a passthrough directory, and you can enable it using an env var while in +conjunction with running Boundary in dev mode: + +```bash +BOUNDARY_DEV_PASSTHROUGH_DIRECTORY=../boundary-ui/ui/core/dist boundary dev +``` diff --git a/website/content/docs/getting-started/run-and-login.mdx b/website/content/docs/getting-started/run-and-login.mdx index 61bf088b7..032ed75d4 100644 --- a/website/content/docs/getting-started/run-and-login.mdx +++ b/website/content/docs/getting-started/run-and-login.mdx @@ -49,17 +49,3 @@ Boundary](https://github.com/hashicorp/terraform-provider-boundary): Note in the example above we're setting `base_url` to `http` and not `https` as the Boundary server does not use TLS in development mode. - -## User Interface - -If you want to develop the Admin UI locally: - -The UI is normally compiled into the Boundary binary at build time. However, it -would be impractical to rebuild the binary on every change when actively -developing the UI. To make UI development more convenient, the binary supports a -_passthrough directory_. This is an arbitrary local directory from which UI -assets are served. Note this option is only available in dev mode. For example: - -```bash -BOUNDARY_DEV_PASSTHROUGH_DIRECTORY=../boundary-ui/ui/core/dist ./boundary dev -```