docs: move developing UI to developing Boundary section (#467)

This commit is contained in:
Jeff Malnick authored and GitHub committed 2020-09-25 23:07:31 -07:00
1 parent 43aa4618e0
commit de700cea87
3 files changed
+25 -16

No files matched your search

+3 -2
View File
@@ -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.
+22
View File
@@ -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
```
@@ -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
```