Merge branch 'master' into pin-docs-python

armadaproject · Jun 28, 2023 · 79fc034 · 79fc034
2 parents 3f359de + 03f6d04
commit 79fc034
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/docs/developer.md b/docs/developer.md
@@ -12,6 +12,12 @@ Want to quickly get Armada running and test it? Install the [Pre-requisites](#pr
 mage localdev minimal testsuite
 ```
 
+To get the UI running, run:
+
+```bash
+mage ui
+```
+
 ## A note for Devs on Arm / Windows
 
 There is limited information on issues that appear on Arm / Windows Machines when running this setup.
@@ -92,9 +98,9 @@ go run cmd/testsuite/main.go test --tests "testsuite/testcases/basic/*" --junit
 
 ### Running the UI
 
-In LocalDev, the UI is pre-built and served from the lookout component. To access it, open http://localhost:8089 in your browser.
+In LocalDev, the UI is built seperately with `mage ui`. To access it, open http://localhost:8089 in your browser.
 
-If you wish to run the UI locally, see the [UI Developer Guide](./developer/ui.md).
+For more information see the [UI Developer Guide](./developer/ui.md).
 
 
 ### Choosing components to run

diff --git a/docs/developer/ui.md b/docs/developer/ui.md
@@ -7,7 +7,7 @@ In short, Lookout is made of two components:
 * Lookout API: a Go service that provides an API to the Armada backend
 * Lookout UI: a React application that provides a web interface to the Lookout API
 
-After running `mage localdev full`, the Lookout UI should be accessible through your browser at `http://localhost:8089`
+After running `mage localdev full` and `mage ui`, the Lookout UI should be accessible through your browser at `http://localhost:8089`
 
 For UI development, you can also use the React development server and skip the build step. Note that the Lookout API service will
 still have to be running for this to work. Browse to `http://localhost:3000` with this.
@@ -16,4 +16,4 @@ cd ./internal/lookout/ui
 yarn run start
 ```
 
-You can also build a production build of the UI by running `mage ui` in the root of the repo.
+You can also re-build a production build of the UI by running `mage ui` in the root of the repo.
diff --git a/magefiles/main.go b/magefiles/main.go
@@ -167,11 +167,14 @@ func LocalDevStop() {
 
 // Build the lookout UI from internal/lookout/ui
 func UI() error {
+	timeTaken := time.Now()
 	mg.Deps(yarnCheck)
 
 	mg.Deps(yarnInstall)
 	mg.Deps(yarnOpenAPI)
 	mg.Deps(yarnBuild)
+
+	fmt.Println("Time to build UI:", time.Since(timeTaken))
 	return nil
 }