From 5b73227f4215fddab134a16bdd24118c59f59ae7 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:13:58 -0400 Subject: [PATCH 1/6] chore: Fix typo in README sample code Signed-off-by: Adam Harvey --- plugins/dynatrace/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/dynatrace/README.md b/plugins/dynatrace/README.md index df6bb75f10..b07fe985fe 100644 --- a/plugins/dynatrace/README.md +++ b/plugins/dynatrace/README.md @@ -49,7 +49,7 @@ const serviceEntityPage = ( + > + + - + ) ``` From ebeac7ccc9a0a026b1248823f579c109a3d299ba Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:16:21 -0400 Subject: [PATCH 2/6] chore: Add API Reference Signed-off-by: Adam Harvey --- plugins/analytics-module-ga/api-report.md | 2 -- plugins/analytics-module-ga/src/index.ts | 6 ++++++ plugins/apollo-explorer/api-report.md | 2 -- plugins/apollo-explorer/src/index.ts | 6 ++++++ plugins/dynatrace/api-report.md | 2 -- plugins/dynatrace/src/index.ts | 6 ++++++ 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/plugins/analytics-module-ga/api-report.md b/plugins/analytics-module-ga/api-report.md index 557f472f71..f28c919f33 100644 --- a/plugins/analytics-module-ga/api-report.md +++ b/plugins/analytics-module-ga/api-report.md @@ -25,6 +25,4 @@ export class GoogleAnalytics implements AnalyticsApi { }, ): GoogleAnalytics; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/analytics-module-ga/src/index.ts b/plugins/analytics-module-ga/src/index.ts index fca8d91658..7b96c761fb 100644 --- a/plugins/analytics-module-ga/src/index.ts +++ b/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'; diff --git a/plugins/apollo-explorer/api-report.md b/plugins/apollo-explorer/api-report.md index 1d3b41eac1..66cc473d0b 100644 --- a/plugins/apollo-explorer/api-report.md +++ b/plugins/apollo-explorer/api-report.md @@ -40,6 +40,4 @@ export const apolloExplorerPlugin: BackstagePlugin< {}, {} >; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/apollo-explorer/src/index.ts b/plugins/apollo-explorer/src/index.ts index 6d07535fc3..565557e79f 100644 --- a/plugins/apollo-explorer/src/index.ts +++ b/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'; diff --git a/plugins/dynatrace/api-report.md b/plugins/dynatrace/api-report.md index 1677318a9f..1dded736ad 100644 --- a/plugins/dynatrace/api-report.md +++ b/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) ``` diff --git a/plugins/dynatrace/src/index.ts b/plugins/dynatrace/src/index.ts index 0c5da219a5..90688a544f 100644 --- a/plugins/dynatrace/src/index.ts +++ b/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'; From 04ad71e6939d9e43a22c4159006a83b4a4953050 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:17:06 -0400 Subject: [PATCH 3/6] chore(analytics-module-ga): Fix Markdown heading levels Signed-off-by: Adam Harvey --- plugins/analytics-module-ga/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/analytics-module-ga/README.md b/plugins/analytics-module-ga/README.md index d6e2642e2b..6fdfc91306 100644 --- a/plugins/analytics-module-ga/README.md +++ b/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: From 5f211006091328f4168175c88bc0aa9b15270ae4 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:17:44 -0400 Subject: [PATCH 4/6] chore: Properly link up API Reference Signed-off-by: Adam Harvey --- plugins/airbrake/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/airbrake/src/index.ts b/plugins/airbrake/src/index.ts index 717d544dc9..6f189e36b8 100644 --- a/plugins/airbrake/src/index.ts +++ b/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 */ From ac87cddad60dd38e798bbb688043ac754ee81453 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:18:42 -0400 Subject: [PATCH 5/6] chore: Improve API Reference package description Signed-off-by: Adam Harvey --- plugins/adr-backend/src/index.ts | 2 +- plugins/adr/src/index.ts | 2 +- plugins/circleci/src/index.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/adr-backend/src/index.ts b/plugins/adr-backend/src/index.ts index 5cc8f50b72..89c88ab3e7 100644 --- a/plugins/adr-backend/src/index.ts +++ b/plugins/adr-backend/src/index.ts @@ -15,7 +15,7 @@ */ /** - * ADR backend plugin + * Architecture Decision Records backend plugin. * * @packageDocumentation */ diff --git a/plugins/adr/src/index.ts b/plugins/adr/src/index.ts index f24b3ac531..f405621c4a 100644 --- a/plugins/adr/src/index.ts +++ b/plugins/adr/src/index.ts @@ -15,7 +15,7 @@ */ /** - * ADR frontend plugin + * Architecture Decision Records frontend plugin. * * @packageDocumentation */ diff --git a/plugins/circleci/src/index.ts b/plugins/circleci/src/index.ts index e20f5c7d6b..442f774b68 100644 --- a/plugins/circleci/src/index.ts +++ b/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 */ From 7d75f6d9b8fb9d5af12c8225f000c22fc2a5bf5c Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Fri, 17 Mar 2023 22:19:51 -0400 Subject: [PATCH 6/6] chore: Add changeset Signed-off-by: Adam Harvey --- .changeset/pretty-carpets-cross.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .changeset/pretty-carpets-cross.md diff --git a/.changeset/pretty-carpets-cross.md b/.changeset/pretty-carpets-cross.md new file mode 100644 index 0000000000..e479ab5bda --- /dev/null +++ b/.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