docs(plugins/dynatrace): update doc with install processing.

Signed-off-by: Paulo Eduardo Peixoto <pauloeduardo_peixoto@hotmail.com>
2022-12-06 16:03:07 -03:00
parent 09950bee04
commit 5cdd1a916b
2 changed files with 38 additions and 1 deletions
@@ -2,13 +2,17 @@

 Welcome to the Dynatrace plugin!

+![](./assets/plugin.png)
+
 ## Getting started

 This plugin uses the Backstage proxy to communicate with Dynatrace's REST APIs.

 ### Setup

-#### Dynatrace API Key
+#### Requirements
+
+##### Dynatrace API Key

 The Dynatrace plugin will require the following information, to be used in the configuration options detailed below:

@@ -17,6 +21,39 @@ The Dynatrace plugin will require the following information, to be used in the c
  - `entities.read`
  - `problems.read`

+#### Install
+
+1. Install the plugin on your frontend:
+
+```
+yarn add --cwd packages/app @backstage/plugin-dynatrace
+```
+
+2. We created in our catalog the interface for using the integration with Dynatrace.
+
+```diff
+# packages/app/src/components/catalog/EntityPage.tsx
+
+[...]
+ import { DynatraceTab, isDynatraceAvailable } from '@backstage/plugin-dynatrace'
+
+[...]
+
+const serviceEntityPage = (
+  <EntityLayout>
+    [...]
+    <EntityLayout.Route
+      path="/dynatrace"
+      title="Dynatrace"
+      if={isDynatraceAvailable}
+    >
+      <DynatraceTab />
+    </EntityLayout.Route>
+  </EntityLaytou>
+)
+
+```
+
 #### Plugin Configuration

 This plugin requires a proxy endpoint for Dynatrace configured in `app-config.yaml` like so: