From e5a4595f4ba42083bfb3f3fcccafb31243808e90 Mon Sep 17 00:00:00 2001
From: Andre Wanlin <awanlin@rapidrtc.com>
Date: Mon, 18 Oct 2021 07:29:56 -0500
Subject: [PATCH 1/3] Improved setup documentation for backend

Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
---
 .changeset/cold-phones-matter.md       |  5 +++
 plugins/azure-devops-backend/README.md | 51 +++++++++++++++++++++++++-
 2 files changed, 54 insertions(+), 2 deletions(-)
 create mode 100644 .changeset/cold-phones-matter.md

diff --git a/.changeset/cold-phones-matter.md b/.changeset/cold-phones-matter.md
new file mode 100644
index 0000000000..0168c583e6
--- /dev/null
+++ b/.changeset/cold-phones-matter.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-azure-devops-backend': patch
+---
+
+Added documentation for setting up and running the Azure DevOps Backend plugin
diff --git a/plugins/azure-devops-backend/README.md b/plugins/azure-devops-backend/README.md
index 4b278572d8..f3ec4ddd82 100644
--- a/plugins/azure-devops-backend/README.md
+++ b/plugins/azure-devops-backend/README.md
@@ -4,7 +4,11 @@ Simple plugin that proxies requests to the [Azure DevOps](https://docs.microsoft
 
 ## Setup
 
-The following values are read from the configuration file:
+The following sections will help you get the Azure DevOps Backend plugin setup and running
+
+### Configuration
+
+The Azure DevOps plugin requires the following YAML to be added to your app-config.yaml:
 
 ```yaml
 azureDevOps:
@@ -17,8 +21,51 @@ Configuration Details:
 
 - `host` and `token` can be the same as the ones used for the `integration` section
 - `AZURE_TOKEN` environment variable must be set to a [Personal Access Token](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page) with read access to both Code and Build
-- `organization` is your Azure DevOps Organization name or for Azure DevOps Server (on-premise) this will be your Collection name
+- `organization` is your Azure DevOps Services (cloud) Organization name or for Azure DevOps Server (on-premise) this will be your Collection name
+
+### Up and Running
+
+Here's how to get the backend up and running:
+
+1. First we need to add the `@backstage/plugin-azure-devops-backend` package to your backend:
+
+   ```sh
+   # From the Backstage root directory
+   cd packages/backend
+   yarn add @backstage/plugin-azure-devops-backend
+   ```
+
+2. Then we will create a new file named `packages/backend/src/plugins/azure-devops.ts`, and add the
+   following to it:
+
+   ```ts
+   import { createRouter } from '@backstage/plugin-azure-devops-backend';
+   import { Router } from 'express';
+   import type { PluginEnvironment } from '../types';
+
+   export default function createPlugin({
+     logger,
+     config,
+   }: PluginEnvironment): Promise<Router> {
+     return createRouter({ logger, config });
+   }
+   ```
+
+3. Next we wire this into the overall backend router, edit `packages/backend/src/index.ts`:
+
+   ```ts
+   import azureDevOps from './plugins/azuredevops';
+   // ...
+   async function main() {
+     // ...
+     const azureDevOpsEnv = useHotMemoize(module, () => createEnv('azure-devops'));
+     apiRouter.use('/azure-devops', await azureDevOps(azureDevOpsEnv));
+   ```
+
+4. Now run `yarn start-backend` from the repo root
+5. Finally open `http://localhost:7000/api/azure-devops/health` in a browser and it should return `{"status":"ok"}`
 
 ## Links
 
+- [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/azure-devops)
 - [The Backstage homepage](https://backstage.io)

From 78d0f24aa386466e1a41c0ee67569e4e07c9b9bd Mon Sep 17 00:00:00 2001
From: Andre Wanlin <awanlin@rapidrtc.com>
Date: Mon, 18 Oct 2021 07:53:31 -0500
Subject: [PATCH 2/3] Removed changeset as it's not needed for documentation
 changes

Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
---
 .changeset/cold-phones-matter.md | 5 -----
 1 file changed, 5 deletions(-)
 delete mode 100644 .changeset/cold-phones-matter.md

diff --git a/.changeset/cold-phones-matter.md b/.changeset/cold-phones-matter.md
deleted file mode 100644
index 0168c583e6..0000000000
--- a/.changeset/cold-phones-matter.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-'@backstage/plugin-azure-devops-backend': patch
----
-
-Added documentation for setting up and running the Azure DevOps Backend plugin

From 579bbd6286c0b38ff16c28d12a542aba19b9a39b Mon Sep 17 00:00:00 2001
From: Andre Wanlin <awanlin@rapidrtc.com>
Date: Mon, 18 Oct 2021 08:05:11 -0500
Subject: [PATCH 3/3] Fixed typos

Signed-off-by: Andre Wanlin <awanlin@rapidrtc.com>
---
 plugins/azure-devops-backend/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/plugins/azure-devops-backend/README.md b/plugins/azure-devops-backend/README.md
index f3ec4ddd82..6101794cd1 100644
--- a/plugins/azure-devops-backend/README.md
+++ b/plugins/azure-devops-backend/README.md
@@ -4,7 +4,7 @@ Simple plugin that proxies requests to the [Azure DevOps](https://docs.microsoft
 
 ## Setup
 
-The following sections will help you get the Azure DevOps Backend plugin setup and running
+The following sections will help you get the Azure DevOps Backend plugin setup and running.
 
 ### Configuration
 
@@ -54,7 +54,7 @@ Here's how to get the backend up and running:
 3. Next we wire this into the overall backend router, edit `packages/backend/src/index.ts`:
 
    ```ts
-   import azureDevOps from './plugins/azuredevops';
+   import azureDevOps from './plugins/azure-devops';
    // ...
    async function main() {
      // ...