From 32b5aa12d1e4f3bbbcce52ca40061c8b0057daf5 Mon Sep 17 00:00:00 2001 From: jallen2112 Date: Thu, 26 Sep 2024 12:09:02 -0700 Subject: [PATCH 1/3] docs: login to ghcr --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c2307f5..ea921f2 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,14 @@ In the `dependencies` folder, you will find a docker-compose file. Using this wi You will need to update the `.env` file with your `GitHub Org`, `User` and `PAT` (with full repo access) for the API to be able to return a list of teams +You will also need to log into the Github Container Registry to pull down required images + +```bash +echo $GITHUB_TOKEN | docker login ghcr.io -u USERNAME --password-stdin +``` + +Grafana will be available at `http://localhost:3000`. To sign in for the first time refer to [this doc](https://grafana.com/docs/grafana/latest/setup-grafana/sign-in-to-grafana/) + ### Kubernetes If you have a Kubernetes Cluster, we have a quick start guide that installs `Loki DB` and [Liatrio OTel Collector](https://github.com/liatrio/liatrio-otel-collector) (among a few other tools) that can be found [here](https://github.com/liatrio/tag-o11y-quick-start-manifests) @@ -109,7 +117,7 @@ You can do this by setting up a new `Webhook` and configuring the `Webhook` to s - Pull Requests - Deployment Statuses -## Installation into Backstage +## Installation into Backstage (live) To Install this plugin you'll need to do the following: @@ -233,6 +241,10 @@ To Install this plugin you'll need to do the following: - high: 24 (1 day or less) - medium: 168 (1 week or less) +## Installation into Backstage (local) + +To Install this plugin locally for debugging/testing you'll need to do the following: + ## Contributing See [Contributing](./CONTRIBUTING) to Backstage Dora Plugin From cbd20123302cfd0d2ec61927c5eed434b2a89324 Mon Sep 17 00:00:00 2001 From: jallen2112 Date: Thu, 26 Sep 2024 13:47:10 -0700 Subject: [PATCH 2/3] docs: remove unneccessary --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index ea921f2..7343a15 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ You can do this by setting up a new `Webhook` and configuring the `Webhook` to s - Pull Requests - Deployment Statuses -## Installation into Backstage (live) +## Installation into Backstage To Install this plugin you'll need to do the following: @@ -241,10 +241,6 @@ To Install this plugin you'll need to do the following: - high: 24 (1 day or less) - medium: 168 (1 week or less) -## Installation into Backstage (local) - -To Install this plugin locally for debugging/testing you'll need to do the following: - ## Contributing See [Contributing](./CONTRIBUTING) to Backstage Dora Plugin From a0771c6499d294d744a6e75b87d82ac29aceab94 Mon Sep 17 00:00:00 2001 From: jallen2112 Date: Thu, 26 Sep 2024 13:48:05 -0700 Subject: [PATCH 3/3] docs: add words --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7343a15..c96f5fd 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ You will also need to log into the Github Container Registry to pull down requir echo $GITHUB_TOKEN | docker login ghcr.io -u USERNAME --password-stdin ``` -Grafana will be available at `http://localhost:3000`. To sign in for the first time refer to [this doc](https://grafana.com/docs/grafana/latest/setup-grafana/sign-in-to-grafana/) +If needed, Grafana will be available at `http://localhost:3000`. To sign in for the first time refer to [this doc](https://grafana.com/docs/grafana/latest/setup-grafana/sign-in-to-grafana/) ### Kubernetes