From 56f42c3f5a16ddc2de2df7548d3edec299912177 Mon Sep 17 00:00:00 2001 From: Lauren Date: Tue, 20 Aug 2024 16:14:19 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20replace=20broken?= =?UTF-8?q?=20links,=20add=20hyperlinks,=20language=20updates=20(#2445)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR updates the repo READMEs by replacing a broken link and pointing to correct tutorials page, adding hyperlinks to improve readability, and small language updates --- README.md | 15 ++++++++------- ui/admin/README.md | 6 +++--- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 59c447f1c..c7b2e5040 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ List of available project commands. `yarn run ` | Command | Description | |---------------------|---| -| build | Builds Admin UI. | +| build | Builds Admin UI for production. | | test | Runs tests in CI mode. | | lint | Runs ember-template-lint on all of the hbs, js, and sass files. | | compliance:audit | Checks for issues using `yarn audit` with moderate and above criticality.| @@ -119,9 +119,9 @@ of README. ### Building Admin UI for Production -See ui/admin/README.md Building for Production for more information on how to -build the Admin UI. Be sure to set build-related environment variables as -necessary for your target environment, as described in the Admin UI readme. +See [Admin UI README](ui/admin/README.md#building-for-production) for more information on how to +build the Admin UI for production. Be sure to set build-related environment variables as +necessary for your target environment, as described in the [Environment Variables](ui/admin/README.md#environment-variables) section of README. To quickly produce a production build of Admin UI, run from this folder: @@ -174,8 +174,9 @@ EXE archived desktop UI is available at asset location under `zip` folder. This describes how to connect local Boundary UI to your local instance of Boundary. -This assumes you already have up and running a Boundary dev instance in your local environment with a listener `127.0.0.1:9200` (default behaviour). [Learn how to start a local Boundary dev instance](https://learn.hashicorp.com/tutorials/boundary/getting-started-dev?in=boundary/getting-started#start-a-dev-environment). -#### For admin +This assumes you already have up and running a Boundary dev instance in your local environment with a listener `127.0.0.1:9200` (default behaviour). [Learn how to start a local Boundary dev instance](https://developer.hashicorp.com/boundary/tutorials/get-started-community/community-get-started-dev) + +#### For Admin This assumes you are within `boundary-ui/ui/admin`. @@ -185,7 +186,7 @@ Following terminal instructions, open in your browser: `http://localhost:4200/`. Once you open the UI you will see the login screen, authenticate using generated admin login name and password. -#### For desktop +#### For Desktop This assumes you are within `boundary-ui/ui/desktop`. diff --git a/ui/admin/README.md b/ui/admin/README.md index 81720d811..fdbfb267b 100644 --- a/ui/admin/README.md +++ b/ui/admin/README.md @@ -1,6 +1,6 @@ # Admin UI -The admin UI for Boundary. +The Admin UI for Boundary. @@ -39,8 +39,8 @@ List of available project commands. `yarn run ` | Command | Description | | ------- | ----------- | -| build:development | Builds the UI in development mode. | -| build | Builds the UI for production. | +| build:development | Builds the Admin UI in development mode. | +| build | Builds the Admin UI for production. | | lint | Runs all lint commands. | | lint:hbs | Lints `hbs` template files. | | lint:js | Lints `js` files. |