From 0b0396257632d38de2f000673cba73451ebeb4f9 Mon Sep 17 00:00:00 2001 From: AmbrishRamachandiran Date: Tue, 16 Jan 2024 10:21:27 +0530 Subject: [PATCH 1/3] Updated readme document of adr plugin Signed-off-by: AmbrishRamachandiran --- .changeset/curvy-ladybugs-impress.md | 5 +++++ plugins/adr/README.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 .changeset/curvy-ladybugs-impress.md diff --git a/.changeset/curvy-ladybugs-impress.md b/.changeset/curvy-ladybugs-impress.md new file mode 100644 index 0000000000..ffeb76399a --- /dev/null +++ b/.changeset/curvy-ladybugs-impress.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-adr': patch +--- + +Updated Readme document in adr plugin diff --git a/plugins/adr/README.md b/plugins/adr/README.md index e6178f003b..4a1f3a7552 100644 --- a/plugins/adr/README.md +++ b/plugins/adr/README.md @@ -2,7 +2,7 @@ Welcome to the ADR plugin! -This plugin allows you to browse ADRs associated with your entities as well as a way to discover ADRs across others entities via Backstage Search. Use this to learn from the past experience of other projects to guide your own architecture decisions. +This plugin allows you to explore ADRs connected with your entities, as well as discover ADRs across other entities using Backstage Search. Use this to inform your own architectural decisions based on the experiences of previous projects. ![ADR tab](./docs/adr-tab.png) From 41dc09ccb7867a00074a0a4843aa655607c1cfa9 Mon Sep 17 00:00:00 2001 From: AmbrishRamachandiran Date: Tue, 16 Jan 2024 16:43:15 +0530 Subject: [PATCH 2/3] changes done as per review Signed-off-by: AmbrishRamachandiran --- .changeset/curvy-ladybugs-impress.md | 2 +- plugins/adr/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/curvy-ladybugs-impress.md b/.changeset/curvy-ladybugs-impress.md index ffeb76399a..3ea90f513a 100644 --- a/.changeset/curvy-ladybugs-impress.md +++ b/.changeset/curvy-ladybugs-impress.md @@ -2,4 +2,4 @@ '@backstage/plugin-adr': patch --- -Updated Readme document in adr plugin +Updated README document in adr plugin diff --git a/plugins/adr/README.md b/plugins/adr/README.md index 4a1f3a7552..3e8647a8fa 100644 --- a/plugins/adr/README.md +++ b/plugins/adr/README.md @@ -2,7 +2,7 @@ Welcome to the ADR plugin! -This plugin allows you to explore ADRs connected with your entities, as well as discover ADRs across other entities using Backstage Search. Use this to inform your own architectural decisions based on the experiences of previous projects. +This plugin allows you to explore ADRs (Architecture Decision Records) associated with your entities, as well as discover ADRs across other entities using Backstage Search. Use this to inform your own architectural decisions based on the experiences of previous projects. ![ADR tab](./docs/adr-tab.png) From 356707690b391c4133906a2a0238b498bad8349c Mon Sep 17 00:00:00 2001 From: AmbrishRamachandiran Date: Wed, 17 Jan 2024 10:28:30 +0530 Subject: [PATCH 3/3] Updated readme Signed-off-by: AmbrishRamachandiran --- .changeset/curvy-ladybugs-impress.md | 2 +- docs/backend-system/building-backends/08-migrating.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/curvy-ladybugs-impress.md b/.changeset/curvy-ladybugs-impress.md index 3ea90f513a..ab799e4888 100644 --- a/.changeset/curvy-ladybugs-impress.md +++ b/.changeset/curvy-ladybugs-impress.md @@ -2,4 +2,4 @@ '@backstage/plugin-adr': patch --- -Updated README document in adr plugin +Updated README diff --git a/docs/backend-system/building-backends/08-migrating.md b/docs/backend-system/building-backends/08-migrating.md index 2514f0925e..45478d632e 100644 --- a/docs/backend-system/building-backends/08-migrating.md +++ b/docs/backend-system/building-backends/08-migrating.md @@ -757,7 +757,7 @@ implementations that they represent, and being exported from there. ### The Auth Plugin -A basic installation of the auth plugin with a microsoft provider will look as follows. +A basic installation of the auth plugin with a Microsoft provider will look as follows. ```ts title="packages/backend/src/index.ts" const backend = createBackend();