cmd/coordinator: update documentation
Update documentation to reflect changes from the dashboard unification.
For golang/go#34744.
Change-Id: Ifb61207dd61496df0e8e9c96fd05730399e3a4b8
Reviewed-on: https://go-review.googlesource.com/c/build/+/340434
Trust: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Carlos Amedee <carlos@golang.org>
diff --git a/README.md b/README.md
index 978a1ff..5d7b357 100644
--- a/README.md
+++ b/README.md
@@ -18,19 +18,13 @@
The main components of the Go build system are:
-* The **dashboard**, in [app/](https://dev.golang.org/dir/build/app), serves
- https://build.golang.org/. It runs on App Engine and holds the state for
- which builds passed or failed, and stores the build failure logs for
- post-submit failures. (Trybot build failure logs are stored elsewhere).
- The dashboard does not execute any builds on its own.
-
-
* The **coordinator**, in
[cmd/coordinator/](https://dev.golang.org/dir/build/cmd/coordinator/),
- serves https://farmer.golang.org/. It runs on GKE and coordinates the
- whole build system. It finds work to do (both pre-submit "TryBot" work,
- and post-submit work) and executes builds, allocating machines to run the
- builds. It is the owner of all machines.
+ serves https://farmer.golang.org/ and https://build.golang.org/.
+ It runs on GKE and coordinates the whole build system. It finds work
+ to do (both pre-submit "TryBot" work, and post-submit work) and executes
+ builds, allocating machines to run the builds. It is the owner of all machines.
+ It holds the state for which builds passed or failed, and the build logs.
* The Go package in [buildenv/](https://dev.golang.org/dir/build/buildenv/)
contains constants for where the dashboard and coordinator run, for prod,
@@ -67,7 +61,7 @@
over the already-open TCP connection.
These three pools can be viewed at the coordinator's
- http://farmer.golang.org/#pools
+ https://farmer.golang.org/#pools.
* The [env/](https://dev.golang.org/dir/build/env/) directory describes
diff --git a/cmd/coordinator/README.md b/cmd/coordinator/README.md
index cacb16d..870b38e 100644
--- a/cmd/coordinator/README.md
+++ b/cmd/coordinator/README.md
@@ -6,19 +6,23 @@
Run
- go run golang.org/x/build/cmd/coordinator --mode=dev --env=dev
+```sh
+go run golang.org/x/build/cmd/coordinator -mode=dev -env=dev
+```
to start a server on https://localhost:8119. Proceed past the TLS warning and
you should get the homepage. Some features won't work when running locally,
-but you should be able to view the homepage and the builders page and do basic
-sanity checks.
+but you should be able to navigate between the homepage, the dashboard,
+the builders page, and do limited local development and testing.
#### Render the "Trybot Status" page locally
To view/modify the "Trybot Status" page locally, you can run the coordinator
with the `-dev` tag.
- go run -tags=dev golang.org/x/build/cmd/coordinator --mode=dev --env=dev
+```sh
+go run -tags=dev golang.org/x/build/cmd/coordinator -mode=dev -env=dev
+```
Then visit https://localhost:8119/try-dev in your browser.
You should see a trybot status page with some example data.
diff --git a/cmd/coordinator/coordinator.go b/cmd/coordinator/coordinator.go
index 7471978..53d5e04 100644
--- a/cmd/coordinator/coordinator.go
+++ b/cmd/coordinator/coordinator.go
@@ -8,8 +8,8 @@
// The coordinator runs the majority of the Go build system.
//
-// It is responsible for finding build work and executing it,
-// reporting the results to build.golang.org for public display.
+// It is responsible for finding build work, executing it,
+// and displaying the results.
//
// For an overview of the Go build system, see the README at
// the root of the x/build repo.
