Merge pull request #16952 from adamdmharvey/adamdmharvey/improve-api-reference

chore: Improve API Reference

.changeset/pretty-carpets-cross.md

@@ -0,0 +1,11 @@
+---
+'@backstage/plugin-analytics-module-ga': patch
+'@backstage/plugin-apollo-explorer': patch
+'@backstage/plugin-adr-backend': patch
+'@backstage/plugin-dynatrace': patch
+'@backstage/plugin-airbrake': patch
+'@backstage/plugin-circleci': patch
+'@backstage/plugin-adr': patch
+---
+
+chore: Improve API Reference documentation

plugins/adr-backend/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * ADR backend plugin
+ * Architecture Decision Records backend plugin.
  *
  * @packageDocumentation
  */

plugins/adr/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * ADR frontend plugin
+ * Architecture Decision Records frontend plugin.
  *
  * @packageDocumentation
  */

plugins/airbrake/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * The Airbrake plugin provides connectivity between Backstage and Airbrake (https://airbrake.io/).
+ * The Airbrake plugin provides connectivity between Backstage and {@link https://airbrake.io/ | Airbrake}.
  *
  * @packageDocumentation
  */

plugins/analytics-module-ga/README.md

@@ -236,7 +236,7 @@ make and test changes is to do the following:
 Code for the isolated version of the plugin can be found inside the [/dev](./dev)
 directory. Changes to the plugin are hot-reloaded.
 
-#### Recommended Dev Config
+### Recommended Dev Config
 
 Paste this into your `app-config.local.yaml` while developing this plugin:
 

plugins/analytics-module-ga/api-report.md

@@ -25,6 +25,4 @@ export class GoogleAnalytics implements AnalyticsApi {
     },
   ): GoogleAnalytics;
 }
-
-// (No @packageDocumentation comment for this package)
 ```

plugins/analytics-module-ga/src/index.ts

@@ -14,5 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * Analytics Module plugin for Google Analytics.
+ *
+ * @packageDocumentation
+ */
+
 export { analyticsModuleGA } from './plugin';
 export * from './apis/implementations/AnalyticsApi';

plugins/apollo-explorer/api-report.md

@@ -40,6 +40,4 @@ export const apolloExplorerPlugin: BackstagePlugin<
   {},
   {}
 >;
-
-// (No @packageDocumentation comment for this package)
 ```

plugins/apollo-explorer/src/index.ts

@@ -13,4 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/**
+ * Integrates Apollo Explorer graphs as a tool to browse GraphQL API endpoints inside Backstage.
+ *
+ * @packageDocumentation
+ */
 export { apolloExplorerPlugin, ApolloExplorerPage } from './plugin';

plugins/circleci/src/index.ts

@@ -15,7 +15,7 @@
  */
 
 /**
- * A Backstage plugin that integrates towards Circle CI
+ * A Backstage plugin that integrates towards CircleCI.
  *
  * @packageDocumentation
  */

plugins/dynatrace/README.md

@@ -49,7 +49,7 @@ const serviceEntityPage = (
 +    >
 +      <DynatraceTab />
 +    </EntityLayout.Route>
-  </EntityLaytou>
+  </EntityLayout>
 )
 
 ```

plugins/dynatrace/api-report.md

@@ -16,6 +16,4 @@ export const DynatraceTab: () => JSX.Element;
 
 // @public
 export const isDynatraceAvailable: (entity: Entity) => boolean;
-
-// (No @packageDocumentation comment for this package)
 ```

plugins/dynatrace/src/index.ts

@@ -14,4 +14,10 @@
  * limitations under the License.
  */
 
+/**
+ * A Backstage plugin that integrates towards Dynatrace.
+ *
+ * @packageDocumentation
+ */
+
 export { dynatracePlugin, DynatraceTab, isDynatraceAvailable } from './plugin';