From d29f5916408a4ddd00d475fb419b5bfa84105eec Mon Sep 17 00:00:00 2001
From: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Date: Thu, 20 Apr 2023 11:29:06 -0500
Subject: [PATCH] Updated based on feedback

Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
---
 plugins/devtools-backend/api-report.md                 | 2 --
 plugins/devtools-backend/src/api/DevToolsBackendApi.ts | 6 ++++--
 plugins/devtools-backend/src/index.ts                  | 6 ++++++
 plugins/devtools-common/api-report.md                  | 2 --
 plugins/devtools-common/src/index.ts                   | 6 ++++++
 plugins/devtools/api-report.md                         | 2 --
 plugins/devtools/src/index.ts                          | 6 ++++++
 7 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/plugins/devtools-backend/api-report.md b/plugins/devtools-backend/api-report.md
index adf2189512..e28f0697ab 100644
--- a/plugins/devtools-backend/api-report.md
+++ b/plugins/devtools-backend/api-report.md
@@ -36,6 +36,4 @@ export interface RouterOptions {
   // (undocumented)
   permissions: PermissionEvaluator;
 }
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/devtools-backend/src/api/DevToolsBackendApi.ts b/plugins/devtools-backend/src/api/DevToolsBackendApi.ts
index 88bd51fa7e..efd0407b31 100644
--- a/plugins/devtools-backend/src/api/DevToolsBackendApi.ts
+++ b/plugins/devtools-backend/src/api/DevToolsBackendApi.ts
@@ -90,7 +90,7 @@ export class DevToolsBackendApi {
           res.status === 200
             ? ExternalDependencyStatus.healthy
             : ExternalDependencyStatus.unhealthy;
-        this.logger.info(
+        this.logger.debug(
           `Fetch for ${endpoint.name} resulted in status code "${res.status}"`,
         );
       })
@@ -129,7 +129,9 @@ export class DevToolsBackendApi {
           : pingResult.output;
     }
 
-    this.logger.info(`Ping results for ${endpoint.name}: ${pingResult.output}`);
+    this.logger.debug(
+      `Ping results for ${endpoint.name}: ${pingResult.output}`,
+    );
 
     const result: ExternalDependency = {
       name: endpoint.name,
diff --git a/plugins/devtools-backend/src/index.ts b/plugins/devtools-backend/src/index.ts
index 134b797761..e1545e0022 100644
--- a/plugins/devtools-backend/src/index.ts
+++ b/plugins/devtools-backend/src/index.ts
@@ -14,5 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * Backstage DevTools backend plugin that contains the API for retrieving package dependencies and current configuration which is used by the Backstage DevTools frontend plugin.
+ *
+ * @packageDocumentation
+ */
+
 export { DevToolsBackendApi } from './api';
 export * from './service/router';
diff --git a/plugins/devtools-common/api-report.md b/plugins/devtools-common/api-report.md
index dae445abde..7e38ff05b0 100644
--- a/plugins/devtools-common/api-report.md
+++ b/plugins/devtools-common/api-report.md
@@ -69,6 +69,4 @@ export type PackageDependency = {
   name: string;
   versions: string;
 };
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/devtools-common/src/index.ts b/plugins/devtools-common/src/index.ts
index ca1cec9ac1..be7426394b 100644
--- a/plugins/devtools-common/src/index.ts
+++ b/plugins/devtools-common/src/index.ts
@@ -14,5 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * Common types and permissions for the DevTools frontend and backend plugins.
+ *
+ * @packageDocumentation
+ */
+
 export * from './types';
 export * from './permissions';
diff --git a/plugins/devtools/api-report.md b/plugins/devtools/api-report.md
index 3933d50e76..c9cfbf77e5 100644
--- a/plugins/devtools/api-report.md
+++ b/plugins/devtools/api-report.md
@@ -54,6 +54,4 @@ export type SubRoute = {
     }
   >;
 };
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/devtools/src/index.ts b/plugins/devtools/src/index.ts
index 576046ca1b..1077a2518c 100644
--- a/plugins/devtools/src/index.ts
+++ b/plugins/devtools/src/index.ts
@@ -14,5 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * Backstage DevTools frontend plugin with a tab that shows package dependencies and another tab that shows your current configuration.
+ *
+ * @packageDocumentation
+ */
+
 export { devToolsPlugin, DevToolsPage } from './plugin';
 export * from './components';