From c0343df92344021ab52512cdc519de124ed92521 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 14 Sep 2021 18:10:10 +0200 Subject: [PATCH 1/5] package: add missing package descriptions Signed-off-by: Patrik Oldsberg --- packages/catalog-client/package.json | 1 + packages/catalog-model/package.json | 1 + packages/create-app/package.json | 2 +- packages/errors/package.json | 1 + packages/integration-react/package.json | 1 + packages/integration/package.json | 1 + 6 files changed, 6 insertions(+), 1 deletion(-) diff --git a/packages/catalog-client/package.json b/packages/catalog-client/package.json index 2040090fde..c6922d5c1f 100644 --- a/packages/catalog-client/package.json +++ b/packages/catalog-client/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/catalog-client", + "description": "An isomorphic client for the catalog backend", "version": "0.3.19", "main": "src/index.ts", "types": "src/index.ts", diff --git a/packages/catalog-model/package.json b/packages/catalog-model/package.json index a20fb235c6..75574b029f 100644 --- a/packages/catalog-model/package.json +++ b/packages/catalog-model/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/catalog-model", + "description": "Types and validators that help describe the model of a Backstage Catalog", "version": "0.9.2", "main": "src/index.ts", "types": "src/index.ts", diff --git a/packages/create-app/package.json b/packages/create-app/package.json index aac845093f..e0ff33e48c 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "@backstage/create-app", - "description": "Create app package for Backstage", + "description": "A CLI that helps you create your own Backstage app", "version": "0.3.40", "private": false, "publishConfig": { diff --git a/packages/errors/package.json b/packages/errors/package.json index dc31d8827e..a9911ce88f 100644 --- a/packages/errors/package.json +++ b/packages/errors/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/errors", + "description": "Common utilities for error handling within Backstage", "version": "0.1.2", "main": "src/index.ts", "types": "src/index.ts", diff --git a/packages/integration-react/package.json b/packages/integration-react/package.json index 90acb9acd3..dc5beb700a 100644 --- a/packages/integration-react/package.json +++ b/packages/integration-react/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/integration-react", + "description": "Frontend package for managing integrations towards external systems", "version": "0.1.8", "main": "src/index.ts", "types": "src/index.ts", diff --git a/packages/integration/package.json b/packages/integration/package.json index 5358912852..7eb1d69b11 100644 --- a/packages/integration/package.json +++ b/packages/integration/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/integration", + "description": "Helpers for managing integrations towards external systems", "version": "0.6.3", "main": "src/index.ts", "types": "src/index.ts", From 71f63563902be7c683c28ceacb36929d58ad0243 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 14 Sep 2021 18:33:40 +0200 Subject: [PATCH 2/5] plugins: add package descriptions Signed-off-by: Patrik Oldsberg --- plugins/allure/package.json | 1 + plugins/api-docs/package.json | 1 + plugins/app-backend/package.json | 1 + plugins/auth-backend/package.json | 1 + plugins/badges-backend/package.json | 1 + plugins/badges/package.json | 1 + plugins/bitrise/package.json | 1 + plugins/catalog-backend-module-ldap/package.json | 1 + plugins/catalog-backend-module-msgraph/package.json | 1 + plugins/catalog-backend/package.json | 1 + plugins/catalog-graphql/package.json | 1 + plugins/catalog-import/package.json | 1 + plugins/catalog-react/package.json | 1 + plugins/catalog/package.json | 1 + plugins/circleci/package.json | 1 + plugins/cloudbuild/package.json | 1 + plugins/code-coverage-backend/package.json | 1 + plugins/code-coverage/package.json | 1 + plugins/config-schema/package.json | 1 + plugins/cost-insights/package.json | 1 + plugins/explore-react/package.json | 1 + plugins/explore/package.json | 1 + plugins/firehydrant/package.json | 1 + plugins/fossa/package.json | 1 + plugins/gcp-projects/package.json | 1 + plugins/git-release-manager/package.json | 1 + plugins/github-actions/package.json | 1 + plugins/github-deployments/package.json | 1 + plugins/gitops-profiles/package.json | 1 + plugins/graphql/package.json | 1 + plugins/home/package.json | 1 + plugins/ilert/package.json | 1 + plugins/jenkins-backend/package.json | 1 + plugins/jenkins/package.json | 1 + plugins/kafka-backend/package.json | 1 + plugins/kafka/package.json | 1 + plugins/kubernetes-backend/package.json | 1 + plugins/kubernetes/package.json | 1 + plugins/lighthouse/package.json | 1 + plugins/newrelic/package.json | 1 + plugins/org/package.json | 1 + plugins/pagerduty/package.json | 1 + plugins/proxy-backend/package.json | 1 + plugins/rollbar-backend/package.json | 1 + plugins/rollbar/package.json | 1 + plugins/scaffolder-backend-module-cookiecutter/package.json | 1 + plugins/scaffolder-backend-module-rails/package.json | 1 + plugins/scaffolder-backend/package.json | 1 + plugins/scaffolder/package.json | 1 + plugins/search-backend-module-elasticsearch/package.json | 1 + plugins/search-backend-module-pg/package.json | 1 + plugins/search-backend-node/package.json | 1 + plugins/search-backend/package.json | 1 + plugins/search/package.json | 1 + plugins/sentry/package.json | 1 + plugins/shortcuts/package.json | 1 + plugins/sonarqube/package.json | 1 + plugins/splunk-on-call/package.json | 1 + plugins/tech-radar/package.json | 1 + plugins/techdocs-backend/package.json | 1 + plugins/techdocs/package.json | 1 + plugins/todo-backend/package.json | 1 + plugins/todo/package.json | 1 + plugins/user-settings/package.json | 1 + plugins/welcome/package.json | 1 + plugins/xcmetrics/package.json | 1 + 66 files changed, 66 insertions(+) diff --git a/plugins/allure/package.json b/plugins/allure/package.json index efa44cb6f8..2c5db4ce6a 100644 --- a/plugins/allure/package.json +++ b/plugins/allure/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-allure", + "description": "A Backstage plugin that integrates with Allure", "version": "0.1.1", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/api-docs/package.json b/plugins/api-docs/package.json index 63871ce4e1..a633cf7a7a 100644 --- a/plugins/api-docs/package.json +++ b/plugins/api-docs/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-api-docs", + "description": "A Backstage plugin that helps represent API entities in the frontend", "version": "0.6.7", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/app-backend/package.json b/plugins/app-backend/package.json index a201ab6411..3b07366de3 100644 --- a/plugins/app-backend/package.json +++ b/plugins/app-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-app-backend", + "description": "A Backstage backend plugin that serves the Backstage frontend app", "version": "0.3.16", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/auth-backend/package.json b/plugins/auth-backend/package.json index afd8006596..60d7f01a7d 100644 --- a/plugins/auth-backend/package.json +++ b/plugins/auth-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-auth-backend", + "description": "A Backstage backend plugin that handles authentication", "version": "0.3.24", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/badges-backend/package.json b/plugins/badges-backend/package.json index 13fca312e0..9f8c2021ad 100644 --- a/plugins/badges-backend/package.json +++ b/plugins/badges-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-badges-backend", + "description": "A Backstage backend plugin that generates README badges for your entities", "version": "0.1.9", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/badges/package.json b/plugins/badges/package.json index 8b286599e5..682b1fe5d1 100644 --- a/plugins/badges/package.json +++ b/plugins/badges/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-badges", + "description": "A Backstage plugin that generates README badges for your entities", "version": "0.2.8", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/bitrise/package.json b/plugins/bitrise/package.json index a476d0f4cb..cce407dfc1 100644 --- a/plugins/bitrise/package.json +++ b/plugins/bitrise/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-bitrise", + "description": "A Backstage plugin that integrates towards Bitrise", "version": "0.1.11", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-backend-module-ldap/package.json b/plugins/catalog-backend-module-ldap/package.json index 1712ef5bfd..5909c28a98 100644 --- a/plugins/catalog-backend-module-ldap/package.json +++ b/plugins/catalog-backend-module-ldap/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog-backend-module-ldap", + "description": "A Backstage catalog backend modules that helps integrate towards LDAP", "version": "0.3.0", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-backend-module-msgraph/package.json b/plugins/catalog-backend-module-msgraph/package.json index f9a13b41ee..4209630cc5 100644 --- a/plugins/catalog-backend-module-msgraph/package.json +++ b/plugins/catalog-backend-module-msgraph/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog-backend-module-msgraph", + "description": "A Backstage catalog backend modules that helps integrate towards Microsoft Graph", "version": "0.2.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-backend/package.json b/plugins/catalog-backend/package.json index 91cd38614d..21f7258720 100644 --- a/plugins/catalog-backend/package.json +++ b/plugins/catalog-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog-backend", + "description": "The Backstage backend plugin that provides the Backstage catalog", "version": "0.13.7", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-graphql/package.json b/plugins/catalog-graphql/package.json index da847d9fa9..a6e9f6efb8 100644 --- a/plugins/catalog-graphql/package.json +++ b/plugins/catalog-graphql/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog-graphql", + "description": "An experimental Backstage catalog GraphQL module", "version": "0.2.12", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-import/package.json b/plugins/catalog-import/package.json index 047a55e716..ab8600b056 100644 --- a/plugins/catalog-import/package.json +++ b/plugins/catalog-import/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog-import", + "description": "A Backstage plugin the helps you import entities into your catalog", "version": "0.5.20", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog-react/package.json b/plugins/catalog-react/package.json index 3d9aed01c5..8010763a5a 100644 --- a/plugins/catalog-react/package.json +++ b/plugins/catalog-react/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog-react", + "description": "A frontend library that helps other Backstage plugins interact with the catalog", "version": "0.4.5", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/catalog/package.json b/plugins/catalog/package.json index b7a843d954..5e5cc0f8bc 100644 --- a/plugins/catalog/package.json +++ b/plugins/catalog/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-catalog", + "description": "The Backstage plugin for browsing the Backstage catalog", "version": "0.6.14", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/circleci/package.json b/plugins/circleci/package.json index 466171e6ac..e314dd4599 100644 --- a/plugins/circleci/package.json +++ b/plugins/circleci/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-circleci", + "description": "A Backstage plugin that integrates towards Circle CI", "version": "0.2.22", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/cloudbuild/package.json b/plugins/cloudbuild/package.json index 6ae81ba6e4..8b130d0e5c 100644 --- a/plugins/cloudbuild/package.json +++ b/plugins/cloudbuild/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-cloudbuild", + "description": "A Backstage plugin that integrates towards Google Cloud Build", "version": "0.2.22", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/code-coverage-backend/package.json b/plugins/code-coverage-backend/package.json index d5c7e21d9c..7f1a9e2d5c 100644 --- a/plugins/code-coverage-backend/package.json +++ b/plugins/code-coverage-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-code-coverage-backend", + "description": "A Backstage backend plugin that helps you keep track of your code coverage", "version": "0.1.10", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/code-coverage/package.json b/plugins/code-coverage/package.json index 061e4108c1..171f09293c 100644 --- a/plugins/code-coverage/package.json +++ b/plugins/code-coverage/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-code-coverage", + "description": "A Backstage plugin that helps you keep track of your code coverage", "version": "0.1.10", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/config-schema/package.json b/plugins/config-schema/package.json index b6fb078a6a..f506541997 100644 --- a/plugins/config-schema/package.json +++ b/plugins/config-schema/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-config-schema", + "description": "A Backstage plugin that lets you browse the configuration schema of your app", "version": "0.1.6", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/cost-insights/package.json b/plugins/cost-insights/package.json index f4cad51d21..84b1d4a25a 100644 --- a/plugins/cost-insights/package.json +++ b/plugins/cost-insights/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-cost-insights", + "description": "A Backstage plugin that helps you keep track of your cloud spend", "version": "0.11.5", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/explore-react/package.json b/plugins/explore-react/package.json index a7e9a7ffe2..08eb02683c 100644 --- a/plugins/explore-react/package.json +++ b/plugins/explore-react/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-explore-react", + "description": "A frontend library for Backstage plugins that want to interact with the explore plugin", "version": "0.0.6", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/explore/package.json b/plugins/explore/package.json index 85e9e32669..24eaacd6d9 100644 --- a/plugins/explore/package.json +++ b/plugins/explore/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-explore", + "description": "A Backstage plugin for building an exploration page of your software ecosystem", "version": "0.3.15", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/firehydrant/package.json b/plugins/firehydrant/package.json index 551c6af021..2b1a595642 100644 --- a/plugins/firehydrant/package.json +++ b/plugins/firehydrant/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-firehydrant", + "description": "A Backstage plugin that integrates towards FireHydrant", "version": "0.1.2", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/fossa/package.json b/plugins/fossa/package.json index 7fb897095b..86c75f16c6 100644 --- a/plugins/fossa/package.json +++ b/plugins/fossa/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-fossa", + "description": "A Backstage plugin that integrates towards FOSSA", "version": "0.2.15", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/gcp-projects/package.json b/plugins/gcp-projects/package.json index 0e8028d0b8..085a4cecb6 100644 --- a/plugins/gcp-projects/package.json +++ b/plugins/gcp-projects/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-gcp-projects", + "description": "A Backstage plugin that helps you manage projects in GCP", "version": "0.3.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/git-release-manager/package.json b/plugins/git-release-manager/package.json index 8a6cd56e37..d54bec4ba1 100644 --- a/plugins/git-release-manager/package.json +++ b/plugins/git-release-manager/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-git-release-manager", + "description": "A Backstage plugin that helps you manage releases in git", "version": "0.2.5", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/github-actions/package.json b/plugins/github-actions/package.json index 97bbee8913..603b17a3bb 100644 --- a/plugins/github-actions/package.json +++ b/plugins/github-actions/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-github-actions", + "description": "A Backstage plugin that integrates towards GitHub Actions", "version": "0.4.17", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/github-deployments/package.json b/plugins/github-deployments/package.json index f5439d9bc6..5f079efed9 100644 --- a/plugins/github-deployments/package.json +++ b/plugins/github-deployments/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-github-deployments", + "description": "A Backstage plugin that integrates towards GitHub Deployments", "version": "0.1.15", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/gitops-profiles/package.json b/plugins/gitops-profiles/package.json index cec185dadc..e6436ff677 100644 --- a/plugins/gitops-profiles/package.json +++ b/plugins/gitops-profiles/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-gitops-profiles", + "description": "A Backstage plugin that helps you manage GitOps profiles", "version": "0.3.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/graphql/package.json b/plugins/graphql/package.json index a03610f097..e6bfe39215 100644 --- a/plugins/graphql/package.json +++ b/plugins/graphql/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-graphql-backend", + "description": "An experimental Backstage backend plugin for GraphQL", "version": "0.1.9", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/home/package.json b/plugins/home/package.json index aaf8993d23..afb48a4a70 100644 --- a/plugins/home/package.json +++ b/plugins/home/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-home", + "description": "A Backstage plugin that helps you build a home page", "version": "0.3.0", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/ilert/package.json b/plugins/ilert/package.json index 689a4ec957..f09e72f4e8 100644 --- a/plugins/ilert/package.json +++ b/plugins/ilert/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-ilert", + "description": "A Backstage plugin that integrates towards iLert", "version": "0.1.10", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/jenkins-backend/package.json b/plugins/jenkins-backend/package.json index 75244f619f..3650f80423 100644 --- a/plugins/jenkins-backend/package.json +++ b/plugins/jenkins-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-jenkins-backend", + "description": "A Backstage backend plugin that integrates towards Jenkins", "version": "0.1.4", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/jenkins/package.json b/plugins/jenkins/package.json index b25cffef61..da764f2f4f 100644 --- a/plugins/jenkins/package.json +++ b/plugins/jenkins/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-jenkins", + "description": "A Backstage plugin that integrates towards Jenkins", "version": "0.5.5", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/kafka-backend/package.json b/plugins/kafka-backend/package.json index 9ff315b3f7..0952e335cb 100644 --- a/plugins/kafka-backend/package.json +++ b/plugins/kafka-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-kafka-backend", + "description": "A Backstage backend plugin that integrates towards Kafka", "version": "0.2.9", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/kafka/package.json b/plugins/kafka/package.json index 06fb56a17e..8eb865a99a 100644 --- a/plugins/kafka/package.json +++ b/plugins/kafka/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-kafka", + "description": "A Backstage plugin that integrates towards Kafka", "version": "0.2.14", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/kubernetes-backend/package.json b/plugins/kubernetes-backend/package.json index ce41e216b3..fdba331c07 100644 --- a/plugins/kubernetes-backend/package.json +++ b/plugins/kubernetes-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-kubernetes-backend", + "description": "A Backstage backend plugin that integrates towards Kubernetes", "version": "0.3.15", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/kubernetes/package.json b/plugins/kubernetes/package.json index fe4391e1f7..7e4b5012d2 100644 --- a/plugins/kubernetes/package.json +++ b/plugins/kubernetes/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-kubernetes", + "description": "A Backstage plugin that integrates towards Kubernetes", "version": "0.4.12", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/lighthouse/package.json b/plugins/lighthouse/package.json index 8702dc8f99..2459ab5f56 100644 --- a/plugins/lighthouse/package.json +++ b/plugins/lighthouse/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-lighthouse", + "description": "A Backstage plugin that integrates towards Lighthouse", "version": "0.2.24", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/newrelic/package.json b/plugins/newrelic/package.json index 16a03ec473..c5d29954f7 100644 --- a/plugins/newrelic/package.json +++ b/plugins/newrelic/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-newrelic", + "description": "A Backstage plugin that integrates towards New Relic", "version": "0.3.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/org/package.json b/plugins/org/package.json index 60abb61e74..e5ab95fab1 100644 --- a/plugins/org/package.json +++ b/plugins/org/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-org", + "description": "A Backstage plugin that helps you create entity pages for your organization", "version": "0.3.22", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/pagerduty/package.json b/plugins/pagerduty/package.json index ddeaecb462..ccb9254f1d 100644 --- a/plugins/pagerduty/package.json +++ b/plugins/pagerduty/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-pagerduty", + "description": "A Backstage plugin that integrates towards PagerDuty", "version": "0.3.12", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/proxy-backend/package.json b/plugins/proxy-backend/package.json index d19a6fffda..740177d7b4 100644 --- a/plugins/proxy-backend/package.json +++ b/plugins/proxy-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-proxy-backend", + "description": "A Backstage backend plugin that helps you set up proxy endpoints in the backend", "version": "0.2.12", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/rollbar-backend/package.json b/plugins/rollbar-backend/package.json index c10b7a6583..75eb7b9773 100644 --- a/plugins/rollbar-backend/package.json +++ b/plugins/rollbar-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-rollbar-backend", + "description": "A Backstage backend plugin that integrates towards Rollbar", "version": "0.1.14", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/rollbar/package.json b/plugins/rollbar/package.json index e2384b6b1b..35802ac6c4 100644 --- a/plugins/rollbar/package.json +++ b/plugins/rollbar/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-rollbar", + "description": "A Backstage plugin that integrates towards Rollbar", "version": "0.3.13", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/scaffolder-backend-module-cookiecutter/package.json b/plugins/scaffolder-backend-module-cookiecutter/package.json index 18a5d93596..eba8ef3484 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/package.json +++ b/plugins/scaffolder-backend-module-cookiecutter/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-scaffolder-backend-module-cookiecutter", + "description": "A module for the scaffolder backend that lets you template projects using cookiecutter", "version": "0.1.2", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/scaffolder-backend-module-rails/package.json b/plugins/scaffolder-backend-module-rails/package.json index 6e78586532..0b7ccded6c 100644 --- a/plugins/scaffolder-backend-module-rails/package.json +++ b/plugins/scaffolder-backend-module-rails/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-scaffolder-backend-module-rails", + "description": "A module for the scaffolder backend that lets you template projects using Rails", "version": "0.1.5", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/scaffolder-backend/package.json b/plugins/scaffolder-backend/package.json index 6be563abaa..a1cad863ec 100644 --- a/plugins/scaffolder-backend/package.json +++ b/plugins/scaffolder-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-scaffolder-backend", + "description": "The Backstage backend plugin that helps you create new things", "version": "0.15.4", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/scaffolder/package.json b/plugins/scaffolder/package.json index 55f9d3b934..cde9597df7 100644 --- a/plugins/scaffolder/package.json +++ b/plugins/scaffolder/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-scaffolder", + "description": "The Backstage plugin that helps you create new things", "version": "0.11.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/search-backend-module-elasticsearch/package.json b/plugins/search-backend-module-elasticsearch/package.json index 9cfd2422d7..99a30b9dcd 100644 --- a/plugins/search-backend-module-elasticsearch/package.json +++ b/plugins/search-backend-module-elasticsearch/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-search-backend-module-elasticsearch", + "description": "A module for the search backend that implements search using ElasticSearch", "version": "0.0.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/search-backend-module-pg/package.json b/plugins/search-backend-module-pg/package.json index 08ecd93967..1bd4c9fee5 100644 --- a/plugins/search-backend-module-pg/package.json +++ b/plugins/search-backend-module-pg/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-search-backend-module-pg", + "description": "A module for the search backend that implements search using PostgreSQL", "version": "0.2.0", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/search-backend-node/package.json b/plugins/search-backend-node/package.json index f57ad81e18..b2f835d16d 100644 --- a/plugins/search-backend-node/package.json +++ b/plugins/search-backend-node/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-search-backend-node", + "description": "A library for Backstage backend plugins that want to interact with the search backend plugin", "version": "0.4.2", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/search-backend/package.json b/plugins/search-backend/package.json index 300ff80ba1..7d1f4d1cab 100644 --- a/plugins/search-backend/package.json +++ b/plugins/search-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-search-backend", + "description": "The Backstage backend plugin that provides your backstage app with search", "version": "0.2.6", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/search/package.json b/plugins/search/package.json index c60ae7c5d8..49b17f8c66 100644 --- a/plugins/search/package.json +++ b/plugins/search/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-search", + "description": "The Backstage plugin that provides your backstage app with search", "version": "0.4.10", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/sentry/package.json b/plugins/sentry/package.json index 7241858e78..0a83a49290 100644 --- a/plugins/sentry/package.json +++ b/plugins/sentry/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-sentry", + "description": "A Backstage plugin that integrates towards Sentry", "version": "0.3.20", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/shortcuts/package.json b/plugins/shortcuts/package.json index a5e03e97e4..ef776cd372 100644 --- a/plugins/shortcuts/package.json +++ b/plugins/shortcuts/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-shortcuts", + "description": "A Backstage plugin that provides a shortcuts feature to the sidebar", "version": "0.1.7", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/sonarqube/package.json b/plugins/sonarqube/package.json index e821dd0bf5..531ab4740a 100644 --- a/plugins/sonarqube/package.json +++ b/plugins/sonarqube/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-sonarqube", + "description": "", "version": "0.2.1", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/splunk-on-call/package.json b/plugins/splunk-on-call/package.json index b3704d7551..17d80b052d 100644 --- a/plugins/splunk-on-call/package.json +++ b/plugins/splunk-on-call/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-splunk-on-call", + "description": "A Backstage plugin that integrates towards Splunk On-Call", "version": "0.3.9", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/tech-radar/package.json b/plugins/tech-radar/package.json index 46b279c3fd..8e7fff1851 100644 --- a/plugins/tech-radar/package.json +++ b/plugins/tech-radar/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-tech-radar", + "description": "A Backstage plugin that lets you display a Tech Radar for your organization", "version": "0.4.6", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/techdocs-backend/package.json b/plugins/techdocs-backend/package.json index 24317a0146..0667f59295 100644 --- a/plugins/techdocs-backend/package.json +++ b/plugins/techdocs-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-techdocs-backend", + "description": "The Backstage backend plugin that renders technical documentation for your components", "version": "0.10.1", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/techdocs/package.json b/plugins/techdocs/package.json index 2628ac925c..e16b11ceb7 100644 --- a/plugins/techdocs/package.json +++ b/plugins/techdocs/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-techdocs", + "description": "The Backstage plugin that renders technical documentation for your components", "version": "0.11.1", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/todo-backend/package.json b/plugins/todo-backend/package.json index 2b2b548620..23da38e948 100644 --- a/plugins/todo-backend/package.json +++ b/plugins/todo-backend/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-todo-backend", + "description": "A Backstage backend plugin that lets you browse TODO comments in your source code", "version": "0.1.11", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/todo/package.json b/plugins/todo/package.json index 73b29f14e1..0cc43bb00e 100644 --- a/plugins/todo/package.json +++ b/plugins/todo/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-todo", + "description": "A Backstage plugin that lets you browse TODO comments in your source code", "version": "0.1.9", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/user-settings/package.json b/plugins/user-settings/package.json index 73208f3ec6..c7866ff758 100644 --- a/plugins/user-settings/package.json +++ b/plugins/user-settings/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-user-settings", + "description": "A Backstage plugin that provides a settings page", "version": "0.3.4", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/welcome/package.json b/plugins/welcome/package.json index 07989801c8..60df9b38c4 100644 --- a/plugins/welcome/package.json +++ b/plugins/welcome/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-welcome", + "description": "An old Backstage plugin that provides a welcome page", "version": "0.3.3", "main": "src/index.ts", "types": "src/index.ts", diff --git a/plugins/xcmetrics/package.json b/plugins/xcmetrics/package.json index a5cadb03ac..670da06f63 100644 --- a/plugins/xcmetrics/package.json +++ b/plugins/xcmetrics/package.json @@ -1,5 +1,6 @@ { "name": "@backstage/plugin-xcmetrics", + "description": "A Backstage plugin that shows XCode build metrics for your components", "version": "0.2.4", "main": "src/index.ts", "types": "src/index.ts", From 8142a8ecb299a891a70d49e09f34fd039afa526e Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 14 Sep 2021 18:35:59 +0200 Subject: [PATCH 3/5] packages,plugins: add package documentation Signed-off-by: Patrik Oldsberg --- packages/backend-common/api-report.md | 2 -- packages/backend-common/src/index.ts | 6 ++++++ packages/backend-test-utils/api-report.md | 2 -- packages/backend-test-utils/src/index.ts | 6 ++++++ packages/catalog-client/api-report.md | 2 -- packages/catalog-client/src/index.ts | 6 ++++++ packages/catalog-model/api-report.md | 9 +++------ packages/catalog-model/src/index.ts | 6 ++++++ packages/cli-common/api-report.md | 2 -- packages/cli-common/src/index.ts | 6 ++++++ packages/cli/src/index.ts | 6 ++++++ packages/codemods/src/index.ts | 6 ++++++ packages/config-loader/api-report.md | 2 -- packages/config-loader/src/index.ts | 6 ++++++ packages/config/api-report.md | 2 -- packages/config/src/index.ts | 6 ++++++ packages/core-app-api/api-report.md | 9 +++------ packages/core-app-api/src/index.ts | 6 ++++++ packages/core-components/api-report.md | 2 -- packages/core-components/src/index.ts | 6 ++++++ packages/core-plugin-api/api-report.md | 2 -- packages/core-plugin-api/src/index.ts | 6 ++++++ packages/create-app/src/index.ts | 6 ++++++ packages/dev-utils/api-report.md | 2 -- packages/dev-utils/src/index.ts | 6 ++++++ packages/errors/api-report.md | 2 -- packages/errors/src/index.ts | 6 ++++++ packages/integration-react/api-report.md | 2 -- packages/integration-react/src/index.ts | 6 ++++++ packages/integration/api-report.md | 2 -- packages/integration/src/index.ts | 6 ++++++ packages/search-common/api-report.md | 2 -- packages/search-common/src/index.ts | 7 +++++++ packages/techdocs-common/api-report.md | 2 -- packages/techdocs-common/src/index.ts | 7 +++++++ packages/test-utils-core/api-report.md | 2 -- packages/test-utils-core/src/index.ts | 7 +++++++ packages/test-utils/api-report.md | 2 -- packages/test-utils/src/index.ts | 7 +++++++ packages/theme/api-report.md | 2 -- packages/theme/src/index.ts | 6 ++++++ packages/version-bridge/api-report.md | 2 -- packages/version-bridge/src/index.ts | 6 ++++++ plugins/allure/api-report.md | 2 -- plugins/allure/src/index.ts | 7 +++++++ plugins/api-docs/api-report.md | 2 -- plugins/api-docs/src/index.ts | 6 ++++++ plugins/app-backend/api-report.md | 2 -- plugins/app-backend/src/index.ts | 6 ++++++ plugins/auth-backend/api-report.md | 2 -- plugins/auth-backend/src/index.ts | 6 ++++++ plugins/badges-backend/api-report.md | 2 -- plugins/badges-backend/src/index.ts | 6 ++++++ plugins/badges/api-report.md | 2 -- plugins/badges/src/index.ts | 6 ++++++ plugins/bitrise/api-report.md | 2 -- plugins/bitrise/src/index.ts | 6 ++++++ plugins/catalog-backend-module-ldap/api-report.md | 2 -- plugins/catalog-backend-module-ldap/src/index.ts | 6 ++++++ plugins/catalog-backend-module-msgraph/api-report.md | 2 -- plugins/catalog-backend-module-msgraph/src/index.ts | 6 ++++++ plugins/catalog-backend/api-report.md | 2 -- plugins/catalog-backend/src/index.ts | 6 ++++++ plugins/catalog-graphql/api-report.md | 2 -- plugins/catalog-graphql/src/index.ts | 6 ++++++ plugins/catalog-import/api-report.md | 2 -- plugins/catalog-import/src/index.ts | 6 ++++++ plugins/catalog-react/api-report.md | 2 -- plugins/catalog-react/src/index.ts | 7 +++++++ plugins/catalog/api-report.md | 2 -- plugins/catalog/src/index.ts | 6 ++++++ plugins/circleci/api-report.md | 2 -- plugins/circleci/src/index.ts | 6 ++++++ plugins/cloudbuild/api-report.md | 2 -- plugins/cloudbuild/src/index.ts | 7 +++++++ plugins/code-coverage-backend/api-report.md | 2 -- plugins/code-coverage-backend/src/index.ts | 6 ++++++ plugins/code-coverage/api-report.md | 2 -- plugins/code-coverage/src/index.ts | 7 +++++++ plugins/config-schema/api-report.md | 2 -- plugins/config-schema/src/index.ts | 6 ++++++ plugins/cost-insights/api-report.md | 2 -- plugins/cost-insights/src/index.ts | 6 ++++++ plugins/explore-react/api-report.md | 2 -- plugins/explore-react/src/index.ts | 6 ++++++ plugins/explore/api-report.md | 2 -- plugins/explore/src/index.ts | 6 ++++++ plugins/firehydrant/api-report.md | 2 -- plugins/firehydrant/src/index.ts | 7 +++++++ plugins/fossa/api-report.md | 2 -- plugins/fossa/src/index.ts | 6 ++++++ plugins/gcp-projects/api-report.md | 2 -- plugins/gcp-projects/src/index.ts | 6 ++++++ plugins/git-release-manager/api-report.md | 10 ++++------ plugins/git-release-manager/src/index.ts | 6 ++++++ plugins/github-actions/api-report.md | 2 -- plugins/github-actions/src/index.ts | 6 ++++++ plugins/github-deployments/api-report.md | 2 -- plugins/github-deployments/src/index.ts | 7 +++++++ plugins/gitops-profiles/api-report.md | 2 -- plugins/gitops-profiles/src/index.ts | 6 ++++++ plugins/graphiql/src/index.ts | 6 ++++++ plugins/graphql/api-report.md | 2 -- plugins/graphql/src/index.ts | 6 ++++++ plugins/home/api-report.md | 2 -- plugins/home/src/index.ts | 6 ++++++ plugins/ilert/src/index.ts | 7 +++++++ plugins/jenkins-backend/api-report.md | 2 -- plugins/jenkins-backend/src/index.ts | 6 ++++++ plugins/jenkins/api-report.md | 2 -- plugins/jenkins/src/index.ts | 6 ++++++ plugins/kafka-backend/api-report.md | 2 -- plugins/kafka-backend/src/index.ts | 6 ++++++ plugins/kafka/api-report.md | 2 -- plugins/kafka/src/index.ts | 7 +++++++ plugins/kubernetes-backend/api-report.md | 2 -- plugins/kubernetes-backend/src/index.ts | 6 ++++++ plugins/kubernetes-common/api-report.md | 2 -- plugins/kubernetes-common/src/index.ts | 6 ++++++ plugins/kubernetes/api-report.md | 2 -- plugins/kubernetes/src/index.ts | 7 +++++++ plugins/lighthouse/api-report.md | 2 -- plugins/lighthouse/src/index.ts | 6 ++++++ plugins/newrelic/api-report.md | 2 -- plugins/newrelic/src/index.ts | 6 ++++++ plugins/org/api-report.md | 2 -- plugins/org/src/index.ts | 7 +++++++ plugins/pagerduty/api-report.md | 2 -- plugins/pagerduty/src/index.ts | 7 +++++++ plugins/proxy-backend/api-report.md | 2 -- plugins/proxy-backend/src/index.ts | 6 ++++++ plugins/rollbar-backend/api-report.md | 2 -- plugins/rollbar-backend/src/index.ts | 6 ++++++ plugins/rollbar/api-report.md | 2 -- plugins/rollbar/src/index.ts | 6 ++++++ .../api-report.md | 2 -- .../src/index.ts | 7 +++++++ plugins/scaffolder-backend-module-rails/api-report.md | 2 -- plugins/scaffolder-backend-module-rails/src/index.ts | 7 +++++++ plugins/scaffolder-backend/api-report.md | 2 -- plugins/scaffolder-backend/src/index.ts | 6 ++++++ plugins/scaffolder/api-report.md | 2 -- plugins/scaffolder/src/index.ts | 6 ++++++ .../search-backend-module-elasticsearch/api-report.md | 2 -- .../search-backend-module-elasticsearch/src/index.ts | 6 ++++++ plugins/search-backend-module-pg/api-report.md | 2 -- plugins/search-backend-module-pg/src/index.ts | 7 +++++++ plugins/search-backend-node/api-report.md | 2 -- plugins/search-backend-node/src/index.ts | 6 ++++++ plugins/search-backend/api-report.md | 2 -- plugins/search-backend/src/index.ts | 6 ++++++ plugins/search/api-report.md | 2 -- plugins/search/src/index.ts | 6 ++++++ plugins/sentry/api-report.md | 2 -- plugins/sentry/src/index.ts | 6 ++++++ plugins/shortcuts/api-report.md | 2 -- plugins/shortcuts/src/index.ts | 7 +++++++ plugins/splunk-on-call/api-report.md | 2 -- plugins/splunk-on-call/src/index.ts | 7 +++++++ plugins/tech-radar/api-report.md | 2 -- plugins/tech-radar/src/index.ts | 6 ++++++ plugins/techdocs-backend/api-report.md | 2 -- plugins/techdocs-backend/src/index.ts | 6 ++++++ plugins/techdocs/api-report.md | 2 -- plugins/techdocs/src/index.ts | 6 ++++++ plugins/todo-backend/api-report.md | 2 -- plugins/todo-backend/src/index.ts | 6 ++++++ plugins/todo/api-report.md | 2 -- plugins/todo/src/index.ts | 6 ++++++ plugins/user-settings/api-report.md | 2 -- plugins/user-settings/src/index.ts | 6 ++++++ plugins/welcome/api-report.md | 2 -- plugins/welcome/src/index.ts | 6 ++++++ plugins/xcmetrics/api-report.md | 2 -- plugins/xcmetrics/src/index.ts | 7 +++++++ 175 files changed, 571 insertions(+), 182 deletions(-) diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index eb1f9ad31f..9f8cf55a38 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -574,6 +574,4 @@ export function useHotCleanup( // @public export function useHotMemoize(_module: NodeModule, valueFactory: () => T): T; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-common/src/index.ts b/packages/backend-common/src/index.ts index f2f38d9aab..4609459faa 100644 --- a/packages/backend-common/src/index.ts +++ b/packages/backend-common/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Common functionality library for Backstage backends + * + * @packageDocumentation + */ + export * from './cache'; export * from './config'; export * from './database'; diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.md index 184ed74978..f31a2675b9 100644 --- a/packages/backend-test-utils/api-report.md +++ b/packages/backend-test-utils/api-report.md @@ -27,6 +27,4 @@ export class TestDatabases { // (undocumented) supports(id: TestDatabaseId): boolean; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-test-utils/src/index.ts b/packages/backend-test-utils/src/index.ts index 7a1a10fc6e..ee66b230a8 100644 --- a/packages/backend-test-utils/src/index.ts +++ b/packages/backend-test-utils/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * Test helpers library for Backstage backends + * + * @packageDocumentation + */ + export * from './database'; export * from './util'; diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index f059174ba3..a645f37ab8 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -140,6 +140,4 @@ export type DiscoveryApi = { // @public export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE = 'backstage.io/catalog-processing'; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/catalog-client/src/index.ts b/packages/catalog-client/src/index.ts index 42a15a27d5..2e81942c2f 100644 --- a/packages/catalog-client/src/index.ts +++ b/packages/catalog-client/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * An isomorphic client for the catalog backend + * + * @packageDocumentation + */ + export { CatalogClient } from './CatalogClient'; export * from './types'; diff --git a/packages/catalog-model/api-report.md b/packages/catalog-model/api-report.md index 407e18a409..7d734339b3 100644 --- a/packages/catalog-model/api-report.md +++ b/packages/catalog-model/api-report.md @@ -278,10 +278,9 @@ export { GroupEntityV1alpha1 }; export const groupEntityV1alpha1Validator: KindValidator; // @public (undocumented) -export type JSONSchema = JSONSchema7 & - { - [key in string]?: JsonValue; - }; +export type JSONSchema = JSONSchema7 & { + [key in string]?: JsonValue; +}; // @public export type KindValidator = { @@ -613,6 +612,4 @@ export const VIEW_URL_ANNOTATION = 'backstage.io/view-url'; // Warnings were encountered during analysis: // // src/entity/Entity.d.ts:38:5 - (ae-incompatible-release-tags) The symbol "status" is marked as @public, but its signature references "UNSTABLE_EntityStatus" which is marked as @alpha - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/catalog-model/src/index.ts b/packages/catalog-model/src/index.ts index c6b9b6b956..ef55337ae2 100644 --- a/packages/catalog-model/src/index.ts +++ b/packages/catalog-model/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Types and validators that help describe the model of a Backstage Catalog + * + * @packageDocumentation + */ + export * from './entity'; export { EntityPolicies } from './EntityPolicies'; export * from './kinds'; diff --git a/packages/cli-common/api-report.md b/packages/cli-common/api-report.md index f129fa3045..371671e63a 100644 --- a/packages/cli-common/api-report.md +++ b/packages/cli-common/api-report.md @@ -23,6 +23,4 @@ export type Paths = { // @public (undocumented) export type ResolveFunc = (...paths: string[]) => string; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/cli-common/src/index.ts b/packages/cli-common/src/index.ts index ed8158366d..e7cda19514 100644 --- a/packages/cli-common/src/index.ts +++ b/packages/cli-common/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Common functionality used by cli, backend, and create-app + * + * @packageDocumentation + */ + export { findPaths } from './paths'; export { isChildPath } from './isChildPath'; export type { Paths, ResolveFunc } from './paths'; diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts index 3e575a495b..286ce6f4d6 100644 --- a/packages/cli/src/index.ts +++ b/packages/cli/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * CLI for developing Backstage plugins and apps + * + * @packageDocumentation + */ + import program from 'commander'; import chalk from 'chalk'; import { exitWithError } from './lib/errors'; diff --git a/packages/codemods/src/index.ts b/packages/codemods/src/index.ts index 0458712522..8eb8840cf0 100644 --- a/packages/codemods/src/index.ts +++ b/packages/codemods/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A collection of codemods for Backstage projects + * + * @packageDocumentation + */ + import program from 'commander'; import chalk from 'chalk'; import { codemods } from './codemods'; diff --git a/packages/config-loader/api-report.md b/packages/config-loader/api-report.md index a674f624b0..bb3ae50d23 100644 --- a/packages/config-loader/api-report.md +++ b/packages/config-loader/api-report.md @@ -73,6 +73,4 @@ export type TransformFunc = ( visibility: ConfigVisibility; }, ) => T | undefined; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/config-loader/src/index.ts b/packages/config-loader/src/index.ts index 29976b52de..0e66c59ec4 100644 --- a/packages/config-loader/src/index.ts +++ b/packages/config-loader/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Config loading functionality used by Backstage backend, and CLI + * + * @packageDocumentation + */ + export { readEnvConfig, loadConfigSchema, mergeConfigSchemas } from './lib'; export type { ConfigSchema, diff --git a/packages/config/api-report.md b/packages/config/api-report.md index 068498b17a..9948aa1e29 100644 --- a/packages/config/api-report.md +++ b/packages/config/api-report.md @@ -90,6 +90,4 @@ export type JsonPrimitive = number | string | boolean | null; // @public export type JsonValue = JsonObject | JsonArray | JsonPrimitive; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/config/src/index.ts b/packages/config/src/index.ts index d45b4e9e75..59b5e8fff8 100644 --- a/packages/config/src/index.ts +++ b/packages/config/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Config API used by Backstage core, backend, and CLI + * + * @packageDocumentation + */ + export { ConfigReader } from './reader'; export type { AppConfig, diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md index 20d8a5a770..95c5b91044 100644 --- a/packages/core-app-api/api-report.md +++ b/packages/core-app-api/api-report.md @@ -187,10 +187,9 @@ export type AppContext = { // @public (undocumented) export type AppOptions = { apis?: Iterable; - icons?: Partial & - { - [key in string]: IconComponent; - }; + icons?: Partial & { + [key in string]: IconComponent; + }; plugins?: BackstagePluginWithAnyOutput[]; components?: Partial; themes?: AppTheme[]; @@ -643,6 +642,4 @@ export class WebStorage implements StorageApi { // src/apis/system/ApiProvider.d.ts:9:5 - (ae-forgotten-export) The symbol "ApiProviderProps" needs to be exported by the entry point index.d.ts // src/app/types.d.ts:88:5 - (ae-forgotten-export) The symbol "UnknownPluginOutput" needs to be exported by the entry point index.d.ts // src/app/types.d.ts:99:5 - (ae-forgotten-export) The symbol "AppIcons" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-app-api/src/index.ts b/packages/core-app-api/src/index.ts index f522bf3a0c..a5e6b649e9 100644 --- a/packages/core-app-api/src/index.ts +++ b/packages/core-app-api/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Core app API used by Backstage apps + * + * @packageDocumentation + */ + export * from './apis'; export * from './app'; export * from './routing'; diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index f3652d98cf..f4539faae0 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -1983,6 +1983,4 @@ export function WarningPanel(props: WarningProps): JSX.Element; // src/components/TabbedLayout/RoutedTabs.d.ts:9:5 - (ae-forgotten-export) The symbol "SubRoute" needs to be exported by the entry point index.d.ts // src/components/Table/Table.d.ts:15:5 - (ae-forgotten-export) The symbol "SelectedFilters" needs to be exported by the entry point index.d.ts // src/layout/ErrorBoundary/ErrorBoundary.d.ts:7:5 - (ae-forgotten-export) The symbol "SlackChannel" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-components/src/index.ts b/packages/core-components/src/index.ts index e13c47b945..af577ce79a 100644 --- a/packages/core-components/src/index.ts +++ b/packages/core-components/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Core components used by Backstage plugins and apps + * + * @packageDocumentation + */ + export * from './components'; export * from './hooks'; export * from './icons'; diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index b87e4511d2..39040d1c91 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -903,6 +903,4 @@ export function withApis(apis: TypesToApiRefs):

( // src/extensions/extensions.d.ts:14:5 - (ae-forgotten-export) The symbol "ComponentLoader" needs to be exported by the entry point index.d.ts // src/routing/RouteRef.d.ts:34:5 - (ae-forgotten-export) The symbol "OldIconComponent" needs to be exported by the entry point index.d.ts // src/routing/types.d.ts:30:5 - (ae-forgotten-export) The symbol "ParamKeys" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/core-plugin-api/src/index.ts b/packages/core-plugin-api/src/index.ts index 28b078357d..f0c1069652 100644 --- a/packages/core-plugin-api/src/index.ts +++ b/packages/core-plugin-api/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Core API used by Backstage plugins + * + * @packageDocumentation + */ + export * from './apis'; export * from './app'; export * from './extensions'; diff --git a/packages/create-app/src/index.ts b/packages/create-app/src/index.ts index 83357d21de..98a3cee908 100644 --- a/packages/create-app/src/index.ts +++ b/packages/create-app/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A CLI that helps you create your own Backstage app + * + * @packageDocumentation + */ + import program from 'commander'; import { exitWithError } from './lib/errors'; import { version } from '../package.json'; diff --git a/packages/dev-utils/api-report.md b/packages/dev-utils/api-report.md index 8d54d8f98d..c10de7d529 100644 --- a/packages/dev-utils/api-report.md +++ b/packages/dev-utils/api-report.md @@ -51,6 +51,4 @@ export const EntityGridItem: ({ }: Omit, 'container' | 'item'> & { entity: Entity; }) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/dev-utils/src/index.ts b/packages/dev-utils/src/index.ts index 908d904362..fcb0b0e659 100644 --- a/packages/dev-utils/src/index.ts +++ b/packages/dev-utils/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * Utilities for developing Backstage plugins. + * + * @packageDocumentation + */ + export * from './components'; export * from './devApp'; diff --git a/packages/errors/api-report.md b/packages/errors/api-report.md index 019b6dd387..429807d9db 100644 --- a/packages/errors/api-report.md +++ b/packages/errors/api-report.md @@ -79,6 +79,4 @@ export function serializeError( includeStack?: boolean; }, ): SerializedError; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/errors/src/index.ts b/packages/errors/src/index.ts index a17d7d171a..afbb688c74 100644 --- a/packages/errors/src/index.ts +++ b/packages/errors/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * Common utilities for error handling within Backstage + * + * @packageDocumentation + */ + export * from './errors'; export * from './serialization'; diff --git a/packages/integration-react/api-report.md b/packages/integration-react/api-report.md index ecd3ae54c3..88057fda74 100644 --- a/packages/integration-react/api-report.md +++ b/packages/integration-react/api-report.md @@ -30,6 +30,4 @@ export class ScmIntegrationsApi { // // @public (undocumented) export const scmIntegrationsApiRef: ApiRef; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/integration-react/src/index.ts b/packages/integration-react/src/index.ts index eb3cc7b761..c308995802 100644 --- a/packages/integration-react/src/index.ts +++ b/packages/integration-react/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * Frontend package for managing integrations towards external systems + * + * @packageDocumentation + */ + export * from './api'; export * from './components'; diff --git a/packages/integration/api-report.md b/packages/integration/api-report.md index 8298d858ee..01f84383fe 100644 --- a/packages/integration/api-report.md +++ b/packages/integration/api-report.md @@ -537,6 +537,4 @@ export interface ScmIntegrationsGroup { // src/github/config.d.ts:41:5 - (ae-forgotten-export) The symbol "GithubAppConfig" needs to be exported by the entry point index.d.ts // src/gitlab/config.d.ts:27:68 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // src/gitlab/config.d.ts:27:63 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/integration/src/index.ts b/packages/integration/src/index.ts index 9bbbab9fce..3d5f336e8d 100644 --- a/packages/integration/src/index.ts +++ b/packages/integration/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Helpers for managing integrations towards external systems + * + * @packageDocumentation + */ + export * from './azure'; export * from './bitbucket'; export * from './github'; diff --git a/packages/search-common/api-report.md b/packages/search-common/api-report.md index f00beb6830..d8d9c2922a 100644 --- a/packages/search-common/api-report.md +++ b/packages/search-common/api-report.md @@ -81,6 +81,4 @@ export interface SearchResultSet { // (undocumented) results: SearchResult[]; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/search-common/src/index.ts b/packages/search-common/src/index.ts index 362949e589..e71f8cd660 100644 --- a/packages/search-common/src/index.ts +++ b/packages/search-common/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * Common functionalities for Search, to be shared between various search-enabled plugins + * + * @packageDocumentation + */ + export * from './types'; diff --git a/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md index edf4bac6db..2f6d2a6f89 100644 --- a/packages/techdocs-common/api-report.md +++ b/packages/techdocs-common/api-report.md @@ -321,6 +321,4 @@ export class UrlPreparer implements PreparerBase { // src/stages/prepare/types.d.ts:19:8 - (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters // src/stages/prepare/types.d.ts:21:33 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag // src/stages/prepare/types.d.ts:21:16 - (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@" - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/techdocs-common/src/index.ts b/packages/techdocs-common/src/index.ts index faf60440c0..a2acf84611 100644 --- a/packages/techdocs-common/src/index.ts +++ b/packages/techdocs-common/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * Common functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli + * + * @packageDocumentation + */ + export * from './stages'; export * from './helpers'; export * from './techdocsTypes'; diff --git a/packages/test-utils-core/api-report.md b/packages/test-utils-core/api-report.md index 7cef987174..4dad7a3a8a 100644 --- a/packages/test-utils-core/api-report.md +++ b/packages/test-utils-core/api-report.md @@ -112,6 +112,4 @@ export function withLogCollector( logsToCollect: T[], callback: SyncLogCollector, ): CollectedLogs; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/test-utils-core/src/index.ts b/packages/test-utils-core/src/index.ts index 89bb7204cc..5658523c11 100644 --- a/packages/test-utils-core/src/index.ts +++ b/packages/test-utils-core/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * Utilities to test Backstage core + * + * @packageDocumentation + */ + export * from './testUtils'; diff --git a/packages/test-utils/api-report.md b/packages/test-utils/api-report.md index 187867d24f..214c26c825 100644 --- a/packages/test-utils/api-report.md +++ b/packages/test-utils/api-report.md @@ -100,6 +100,4 @@ export function wrapInTestApp( ): ReactElement; export * from '@backstage/test-utils-core'; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/test-utils/src/index.ts b/packages/test-utils/src/index.ts index 8c9561a295..545a5b9961 100644 --- a/packages/test-utils/src/index.ts +++ b/packages/test-utils/src/index.ts @@ -13,5 +13,12 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * Utilities to test Backstage plugins and apps. + * + * @packageDocumentation + */ + export * from './testUtils'; export * from '@backstage/test-utils-core'; diff --git a/packages/theme/api-report.md b/packages/theme/api-report.md index a3f6f6dd43..05833e5e91 100644 --- a/packages/theme/api-report.md +++ b/packages/theme/api-report.md @@ -116,6 +116,4 @@ export type SimpleThemeOptions = { pageTheme?: Record; fontFamily?: string; }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/theme/src/index.ts b/packages/theme/src/index.ts index a8b4ade934..93fec977f9 100644 --- a/packages/theme/src/index.ts +++ b/packages/theme/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * material-ui theme for use with Backstage. + * + * @packageDocumentation + */ + export * from './themes'; export * from './baseTheme'; export * from './types'; diff --git a/packages/version-bridge/api-report.md b/packages/version-bridge/api-report.md index eca13071ed..7dd88b1a34 100644 --- a/packages/version-bridge/api-report.md +++ b/packages/version-bridge/api-report.md @@ -45,6 +45,4 @@ export type VersionedValue< version: Version, ): Versions[Version] | undefined; }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/packages/version-bridge/src/index.ts b/packages/version-bridge/src/index.ts index 3e6b2a00f4..305c90bf10 100644 --- a/packages/version-bridge/src/index.ts +++ b/packages/version-bridge/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * Utilities used by Backstage packages to support multiple concurrent versions + * + * @packageDocumentation + */ + export * from './lib'; diff --git a/plugins/allure/api-report.md b/plugins/allure/api-report.md index c39b092954..5489ba4f26 100644 --- a/plugins/allure/api-report.md +++ b/plugins/allure/api-report.md @@ -22,6 +22,4 @@ export const allurePlugin: BackstagePlugin< // // @public (undocumented) export const EntityAllureReportContent: () => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/allure/src/index.ts b/plugins/allure/src/index.ts index 016d33c2ff..d9dbfab056 100644 --- a/plugins/allure/src/index.ts +++ b/plugins/allure/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates with Allure + * + * @packageDocumentation + */ + export { allurePlugin, EntityAllureReportContent } from './plugin'; diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.md index 639485a42d..74a0dc07dd 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.md @@ -183,6 +183,4 @@ export const ProvidedApisCard: ({ variant }: Props_4) => JSX.Element; // // @public (undocumented) export const ProvidingComponentsCard: ({ variant }: Props_7) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/api-docs/src/index.ts b/plugins/api-docs/src/index.ts index b36c9a04c6..fe98e9c70e 100644 --- a/plugins/api-docs/src/index.ts +++ b/plugins/api-docs/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that helps represent API entities in the frontend + * + * @packageDocumentation + */ + export * from './components'; export { apiDocsConfigRef } from './config'; export { diff --git a/plugins/app-backend/api-report.md b/plugins/app-backend/api-report.md index 8c674b34e2..d742b10442 100644 --- a/plugins/app-backend/api-report.md +++ b/plugins/app-backend/api-report.md @@ -24,6 +24,4 @@ export interface RouterOptions { logger: Logger_2; staticFallbackHandler?: express.Handler; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/app-backend/src/index.ts b/plugins/app-backend/src/index.ts index ca73cb27ba..c91416eac1 100644 --- a/plugins/app-backend/src/index.ts +++ b/plugins/app-backend/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that serves the Backstage frontend app + * + * @packageDocumentation + */ + export * from './service/router'; diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md index b499f0bf8e..5dfdd3df16 100644 --- a/plugins/auth-backend/api-report.md +++ b/plugins/auth-backend/api-report.md @@ -473,6 +473,4 @@ export type WebMessageResponse = // src/providers/types.d.ts:109:5 - (ae-forgotten-export) The symbol "AuthProviderConfig" needs to be exported by the entry point index.d.ts // src/providers/types.d.ts:115:5 - (ae-forgotten-export) The symbol "ExperimentalIdentityResolver" needs to be exported by the entry point index.d.ts // src/providers/types.d.ts:132:8 - (tsdoc-missing-deprecation-message) The @deprecated block must include a deprecation message, e.g. describing the recommended alternative - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/auth-backend/src/index.ts b/plugins/auth-backend/src/index.ts index 6b15b1fc81..432da00142 100644 --- a/plugins/auth-backend/src/index.ts +++ b/plugins/auth-backend/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that handles authentication + * + * @packageDocumentation + */ + export * from './service/router'; export { IdentityClient } from './identity'; export type { TokenIssuer } from './identity'; diff --git a/plugins/badges-backend/api-report.md b/plugins/badges-backend/api-report.md index 5723a3f0b8..01b14cc8ee 100644 --- a/plugins/badges-backend/api-report.md +++ b/plugins/badges-backend/api-report.md @@ -139,6 +139,4 @@ export interface RouterOptions { // (undocumented) discovery: PluginEndpointDiscovery; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/badges-backend/src/index.ts b/plugins/badges-backend/src/index.ts index d297627a34..a45714cb81 100644 --- a/plugins/badges-backend/src/index.ts +++ b/plugins/badges-backend/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that generates README badges for your entities + * + * @packageDocumentation + */ + export * from './badges'; export * from './lib'; export * from './service/router'; diff --git a/plugins/badges/api-report.md b/plugins/badges/api-report.md index 9005e34c43..f4ba97cabc 100644 --- a/plugins/badges/api-report.md +++ b/plugins/badges/api-report.md @@ -22,6 +22,4 @@ export const EntityBadgesDialog: ({ open: boolean; onClose?: (() => any) | undefined; }) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/badges/src/index.ts b/plugins/badges/src/index.ts index 52b4cede65..e45c5c2277 100644 --- a/plugins/badges/src/index.ts +++ b/plugins/badges/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage plugin that generates README badges for your entities + * + * @packageDocumentation + */ + export * from './plugin'; diff --git a/plugins/bitrise/api-report.md b/plugins/bitrise/api-report.md index 4d39353113..293ea5fe40 100644 --- a/plugins/bitrise/api-report.md +++ b/plugins/bitrise/api-report.md @@ -22,6 +22,4 @@ export const EntityBitriseContent: () => JSX.Element; // // @public (undocumented) export const isBitriseAvailable: (entity: Entity) => boolean; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/bitrise/src/index.ts b/plugins/bitrise/src/index.ts index db98367e61..3cf1389013 100644 --- a/plugins/bitrise/src/index.ts +++ b/plugins/bitrise/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Bitrise + * + * @packageDocumentation + */ + export { bitrisePlugin } from './plugin'; export { EntityBitriseContent } from './extensions'; export { isBitriseAvailable } from './components/BitriseBuildsComponent'; diff --git a/plugins/catalog-backend-module-ldap/api-report.md b/plugins/catalog-backend-module-ldap/api-report.md index 35f647ec70..fd6e334365 100644 --- a/plugins/catalog-backend-module-ldap/api-report.md +++ b/plugins/catalog-backend-module-ldap/api-report.md @@ -259,6 +259,4 @@ export type UserTransformer = ( // // src/ldap/vendors.d.ts:17:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // src/ldap/vendors.d.ts:18:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-ldap/src/index.ts b/plugins/catalog-backend-module-ldap/src/index.ts index 25353df4c4..a3b3c46815 100644 --- a/plugins/catalog-backend-module-ldap/src/index.ts +++ b/plugins/catalog-backend-module-ldap/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * A Backstage catalog backend modules that helps integrate towards LDAP + * + * @packageDocumentation + */ + export * from './processors'; export * from './ldap'; diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.md index 7a10ad2995..4e58b68cb7 100644 --- a/plugins/catalog-backend-module-msgraph/api-report.md +++ b/plugins/catalog-backend-module-msgraph/api-report.md @@ -195,6 +195,4 @@ export type UserTransformer = ( // Warnings were encountered during analysis: // // src/microsoftGraph/config.d.ts:28:8 - (tsdoc-undefined-tag) The TSDoc tag "@visibility" is not defined in this configuration - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend-module-msgraph/src/index.ts b/plugins/catalog-backend-module-msgraph/src/index.ts index e6654f3147..396ccc3e6a 100644 --- a/plugins/catalog-backend-module-msgraph/src/index.ts +++ b/plugins/catalog-backend-module-msgraph/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * A Backstage catalog backend modules that helps integrate towards Microsoft Graph + * + * @packageDocumentation + */ + export * from './processors'; export * from './microsoftGraph'; diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 9d542c674d..3b3adbf43e 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -1466,6 +1466,4 @@ export class UrlReaderProcessor implements CatalogProcessor { // src/ingestion/processors/types.d.ts:58:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // src/ingestion/types.d.ts:17:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // src/ingestion/types.d.ts:41:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-backend/src/index.ts b/plugins/catalog-backend/src/index.ts index 5f9d6e524c..c56fc4232a 100644 --- a/plugins/catalog-backend/src/index.ts +++ b/plugins/catalog-backend/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage backend plugin that provides the Backstage catalog + * + * @packageDocumentation + */ + export * from './catalog'; export * from './database'; export * from './ingestion'; diff --git a/plugins/catalog-graphql/api-report.md b/plugins/catalog-graphql/api-report.md index ac64559f13..f3795efd9d 100644 --- a/plugins/catalog-graphql/api-report.md +++ b/plugins/catalog-graphql/api-report.md @@ -21,6 +21,4 @@ export interface ModuleOptions { // (undocumented) logger: Logger_2; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-graphql/src/index.ts b/plugins/catalog-graphql/src/index.ts index 0ca48a8830..51ae12e684 100644 --- a/plugins/catalog-graphql/src/index.ts +++ b/plugins/catalog-graphql/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * An experimental Backstage catalog GraphQL module + * + * @packageDocumentation + */ + export * from './graphql/module'; diff --git a/plugins/catalog-import/api-report.md b/plugins/catalog-import/api-report.md index 8466749243..6752f95748 100644 --- a/plugins/catalog-import/api-report.md +++ b/plugins/catalog-import/api-report.md @@ -237,6 +237,4 @@ export const StepPrepareCreatePullRequest: ({ // Warnings were encountered during analysis: // // src/api/CatalogImportApi.d.ts:14:5 - (ae-forgotten-export) The symbol "PartialEntity" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-import/src/index.ts b/plugins/catalog-import/src/index.ts index 9c5993c7fc..adee41bdbd 100644 --- a/plugins/catalog-import/src/index.ts +++ b/plugins/catalog-import/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin the helps you import entities into your catalog + * + * @packageDocumentation + */ + export { catalogImportPlugin, catalogImportPlugin as plugin, diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 5f65426ed3..189c6fc78a 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -857,6 +857,4 @@ export const useStarredEntities: () => { // src/types.d.ts:16:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // src/types.d.ts:22:68 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag // src/types.d.ts:22:88 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog-react/src/index.ts b/plugins/catalog-react/src/index.ts index 4e005c0cdc..1ac67d514b 100644 --- a/plugins/catalog-react/src/index.ts +++ b/plugins/catalog-react/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A frontend library that helps other Backstage plugins interact with the catalog + * + * @packageDocumentation + */ + export type { CatalogApi } from '@backstage/catalog-client'; export { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client'; export { catalogApiRef } from './api'; diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.md index 689c617158..3ea5dfdc01 100644 --- a/plugins/catalog/api-report.md +++ b/plugins/catalog/api-report.md @@ -416,6 +416,4 @@ export const Router: ({ // src/components/EntityLayout/EntityLayout.d.ts:44:5 - (ae-forgotten-export) The symbol "SubRoute" needs to be exported by the entry point index.d.ts // src/components/EntityPageLayout/EntityPageLayout.d.ts:17:5 - (ae-forgotten-export) The symbol "EntityPageLayoutProps" needs to be exported by the entry point index.d.ts // src/plugin.d.ts:22:5 - (ae-forgotten-export) The symbol "ColumnBreakpoints" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/catalog/src/index.ts b/plugins/catalog/src/index.ts index 31184204a9..54f4da5e7e 100644 --- a/plugins/catalog/src/index.ts +++ b/plugins/catalog/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage plugin for browsing the Backstage catalog + * + * @packageDocumentation + */ + export { CatalogClientWrapper } from './CatalogClientWrapper'; export * from './components/AboutCard'; export * from './components/CatalogKindHeader'; diff --git a/plugins/circleci/api-report.md b/plugins/circleci/api-report.md index 76426d8385..25d4af0923 100644 --- a/plugins/circleci/api-report.md +++ b/plugins/circleci/api-report.md @@ -103,6 +103,4 @@ export { isCircleCIAvailable as isPluginApplicableToEntity }; // // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/circleci/src/index.ts b/plugins/circleci/src/index.ts index 1bdaf8f56a..e20f5c7d6b 100644 --- a/plugins/circleci/src/index.ts +++ b/plugins/circleci/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Circle CI + * + * @packageDocumentation + */ + export { circleCIPlugin, circleCIPlugin as plugin, diff --git a/plugins/cloudbuild/api-report.md b/plugins/cloudbuild/api-report.md index 8c0ee26539..fefa4fe344 100644 --- a/plugins/cloudbuild/api-report.md +++ b/plugins/cloudbuild/api-report.md @@ -361,6 +361,4 @@ export interface Volume { // (undocumented) path: string; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/cloudbuild/src/index.ts b/plugins/cloudbuild/src/index.ts index a740bfa8f0..a7466e5124 100644 --- a/plugins/cloudbuild/src/index.ts +++ b/plugins/cloudbuild/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards Google Cloud Build + * + * @packageDocumentation + */ + export { cloudbuildPlugin, cloudbuildPlugin as plugin, diff --git a/plugins/code-coverage-backend/api-report.md b/plugins/code-coverage-backend/api-report.md index 8d92686f2c..9e6a84f542 100644 --- a/plugins/code-coverage-backend/api-report.md +++ b/plugins/code-coverage-backend/api-report.md @@ -43,6 +43,4 @@ export interface RouterOptions { // (undocumented) urlReader: UrlReader; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/code-coverage-backend/src/index.ts b/plugins/code-coverage-backend/src/index.ts index ca73cb27ba..3b1b536ac7 100644 --- a/plugins/code-coverage-backend/src/index.ts +++ b/plugins/code-coverage-backend/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that helps you keep track of your code coverage + * + * @packageDocumentation + */ + export * from './service/router'; diff --git a/plugins/code-coverage/api-report.md b/plugins/code-coverage/api-report.md index 19c1a8b1d5..0e675dec04 100644 --- a/plugins/code-coverage/api-report.md +++ b/plugins/code-coverage/api-report.md @@ -35,6 +35,4 @@ export { isCodeCoverageAvailable as isPluginApplicableToEntity }; // // @public (undocumented) export const Router: () => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/code-coverage/src/index.ts b/plugins/code-coverage/src/index.ts index e15b58db75..2ece7ed1e8 100644 --- a/plugins/code-coverage/src/index.ts +++ b/plugins/code-coverage/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that helps you keep track of your code coverage + * + * @packageDocumentation + */ + export { codeCoveragePlugin, EntityCodeCoverageContent } from './plugin'; export { Router, diff --git a/plugins/config-schema/api-report.md b/plugins/config-schema/api-report.md index 6b0ef9a964..15c00acc18 100644 --- a/plugins/config-schema/api-report.md +++ b/plugins/config-schema/api-report.md @@ -49,6 +49,4 @@ export class StaticSchemaLoader implements ConfigSchemaApi { // (undocumented) schema$(): Observable; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/config-schema/src/index.ts b/plugins/config-schema/src/index.ts index 9bea72eba9..b30f59e7c0 100644 --- a/plugins/config-schema/src/index.ts +++ b/plugins/config-schema/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * A Backstage plugin that lets you browse the configuration schema of your app + * + * @packageDocumentation + */ + export * from './api'; export { configSchemaPlugin, ConfigSchemaPage } from './plugin'; diff --git a/plugins/cost-insights/api-report.md b/plugins/cost-insights/api-report.md index 61ee64859c..f15264f838 100644 --- a/plugins/cost-insights/api-report.md +++ b/plugins/cost-insights/api-report.md @@ -829,6 +829,4 @@ export interface UnlabeledDataflowData { // src/api/CostInsightsApi.d.ts:83:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // src/api/CostInsightsApi.d.ts:84:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // src/api/CostInsightsApi.d.ts:100:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/cost-insights/src/index.ts b/plugins/cost-insights/src/index.ts index 4e94234cb4..b9a4bb83e0 100644 --- a/plugins/cost-insights/src/index.ts +++ b/plugins/cost-insights/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that helps you keep track of your cloud spend + * + * @packageDocumentation + */ + export { costInsightsPlugin, costInsightsPlugin as plugin, diff --git a/plugins/explore-react/api-report.md b/plugins/explore-react/api-report.md index 06d7565559..75fb01064d 100644 --- a/plugins/explore-react/api-report.md +++ b/plugins/explore-react/api-report.md @@ -29,6 +29,4 @@ export interface ExploreToolsConfig { // // @public (undocumented) export const exploreToolsConfigRef: ApiRef; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/explore-react/src/index.ts b/plugins/explore-react/src/index.ts index bc3ddd518a..50bb47600b 100644 --- a/plugins/explore-react/src/index.ts +++ b/plugins/explore-react/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A frontend library for Backstage plugins that want to interact with the explore plugin + * + * @packageDocumentation + */ + export * from './tools'; diff --git a/plugins/explore/api-report.md b/plugins/explore/api-report.md index 2d04574f88..5691707e0e 100644 --- a/plugins/explore/api-report.md +++ b/plugins/explore/api-report.md @@ -93,6 +93,4 @@ export const ToolExplorerContent: ({ // // src/components/ExploreLayout/ExploreLayout.d.ts:29:5 - (ae-forgotten-export) The symbol "ExploreLayoutProps" needs to be exported by the entry point index.d.ts // src/components/ExploreLayout/ExploreLayout.d.ts:30:5 - (ae-forgotten-export) The symbol "SubRoute" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/explore/src/index.ts b/plugins/explore/src/index.ts index b040d383c4..cc1b097bfe 100644 --- a/plugins/explore/src/index.ts +++ b/plugins/explore/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin for building an exploration page of your software ecosystem + * + * @packageDocumentation + */ + export { ExploreLayout } from './components'; export * from './extensions'; export { explorePlugin, explorePlugin as plugin } from './plugin'; diff --git a/plugins/firehydrant/api-report.md b/plugins/firehydrant/api-report.md index 6cd8270178..86f090c34d 100644 --- a/plugins/firehydrant/api-report.md +++ b/plugins/firehydrant/api-report.md @@ -22,6 +22,4 @@ export const firehydrantPlugin: BackstagePlugin< }, {} >; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/firehydrant/src/index.ts b/plugins/firehydrant/src/index.ts index 465e42f1ae..f1ef66fd3e 100644 --- a/plugins/firehydrant/src/index.ts +++ b/plugins/firehydrant/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards FireHydrant + * + * @packageDocumentation + */ + export { firehydrantPlugin, FirehydrantCard } from './plugin'; diff --git a/plugins/fossa/api-report.md b/plugins/fossa/api-report.md index e1b2cb0cf2..50e382d3d4 100644 --- a/plugins/fossa/api-report.md +++ b/plugins/fossa/api-report.md @@ -32,6 +32,4 @@ export const fossaPlugin: BackstagePlugin< }, {} >; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/fossa/src/index.ts b/plugins/fossa/src/index.ts index a834478419..200b977f3b 100644 --- a/plugins/fossa/src/index.ts +++ b/plugins/fossa/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards FOSSA + * + * @packageDocumentation + */ + export { fossaPlugin } from './plugin'; export { EntityFossaCard, FossaPage } from './extensions'; diff --git a/plugins/gcp-projects/api-report.md b/plugins/gcp-projects/api-report.md index 9464a5af6a..8049441b1f 100644 --- a/plugins/gcp-projects/api-report.md +++ b/plugins/gcp-projects/api-report.md @@ -99,6 +99,4 @@ export type Status = { message: string; details: string[]; }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/gcp-projects/src/index.ts b/plugins/gcp-projects/src/index.ts index b2b45d22c8..accfd7eedd 100644 --- a/plugins/gcp-projects/src/index.ts +++ b/plugins/gcp-projects/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that helps you manage projects in GCP + * + * @packageDocumentation + */ + export { gcpProjectsPlugin, gcpProjectsPlugin as plugin, diff --git a/plugins/git-release-manager/api-report.md b/plugins/git-release-manager/api-report.md index f1f9b5181c..4ed142ca04 100644 --- a/plugins/git-release-manager/api-report.md +++ b/plugins/git-release-manager/api-report.md @@ -649,10 +649,8 @@ const VERSIONING_STRATEGIES: { // src/helpers/getBumpedTag.d.ts:14:5 - (ae-forgotten-export) The symbol "Project" needs to be exported by the entry point index.d.ts // src/helpers/getBumpedTag.d.ts:19:5 - (ae-forgotten-export) The symbol "CalverTagParts" needs to be exported by the entry point index.d.ts // src/helpers/getBumpedTag.d.ts:31:5 - (ae-forgotten-export) The symbol "AlertError" needs to be exported by the entry point index.d.ts -// src/index.d.ts:4:5 - (ae-forgotten-export) The symbol "components" needs to be exported by the entry point index.d.ts -// src/index.d.ts:5:5 - (ae-forgotten-export) The symbol "constants" needs to be exported by the entry point index.d.ts -// src/index.d.ts:6:5 - (ae-forgotten-export) The symbol "helpers" needs to be exported by the entry point index.d.ts -// src/index.d.ts:7:5 - (ae-forgotten-export) The symbol "testHelpers" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) +// src/index.d.ts:9:5 - (ae-forgotten-export) The symbol "components" needs to be exported by the entry point index.d.ts +// src/index.d.ts:10:5 - (ae-forgotten-export) The symbol "constants" needs to be exported by the entry point index.d.ts +// src/index.d.ts:11:5 - (ae-forgotten-export) The symbol "helpers" needs to be exported by the entry point index.d.ts +// src/index.d.ts:12:5 - (ae-forgotten-export) The symbol "testHelpers" needs to be exported by the entry point index.d.ts ``` diff --git a/plugins/git-release-manager/src/index.ts b/plugins/git-release-manager/src/index.ts index c325a3335b..ac6b294cbc 100644 --- a/plugins/git-release-manager/src/index.ts +++ b/plugins/git-release-manager/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that helps you manage releases in git + * + * @packageDocumentation + */ + export { gitReleaseManagerPlugin, GitReleaseManagerPage, diff --git a/plugins/github-actions/api-report.md b/plugins/github-actions/api-report.md index 22b5d57d45..fcb3209fb9 100644 --- a/plugins/github-actions/api-report.md +++ b/plugins/github-actions/api-report.md @@ -352,6 +352,4 @@ export type Step = { started_at: string; completed_at: string; }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/github-actions/src/index.ts b/plugins/github-actions/src/index.ts index 05b3860d98..f520b9fbbc 100644 --- a/plugins/github-actions/src/index.ts +++ b/plugins/github-actions/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards GitHub Actions + * + * @packageDocumentation + */ + export { githubActionsPlugin, githubActionsPlugin as plugin, diff --git a/plugins/github-deployments/api-report.md b/plugins/github-deployments/api-report.md index fcc5022d7c..a8fca185e5 100644 --- a/plugins/github-deployments/api-report.md +++ b/plugins/github-deployments/api-report.md @@ -84,6 +84,4 @@ const GithubStateIndicator: ({ state }: { state: string }) => JSX.Element; // // @public (undocumented) export const isGithubDeploymentsAvailable: (entity: Entity) => boolean; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/github-deployments/src/index.ts b/plugins/github-deployments/src/index.ts index a21cc1dca6..55c1d2f2d2 100644 --- a/plugins/github-deployments/src/index.ts +++ b/plugins/github-deployments/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards GitHub Deployments + * + * @packageDocumentation + */ + export { githubDeploymentsPlugin, EntityGithubDeploymentsCard } from './plugin'; export { GithubDeploymentsTable } from './components/GithubDeploymentsTable'; export { isGithubDeploymentsAvailable } from './Router'; diff --git a/plugins/gitops-profiles/api-report.md b/plugins/gitops-profiles/api-report.md index aacdaff966..3c77d0301b 100644 --- a/plugins/gitops-profiles/api-report.md +++ b/plugins/gitops-profiles/api-report.md @@ -230,6 +230,4 @@ export interface StatusResponse { // (undocumented) status: string; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/gitops-profiles/src/index.ts b/plugins/gitops-profiles/src/index.ts index d88b15e0ce..07441629a2 100644 --- a/plugins/gitops-profiles/src/index.ts +++ b/plugins/gitops-profiles/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that helps you manage GitOps profiles + * + * @packageDocumentation + */ + export { gitopsProfilesPlugin, gitopsProfilesPlugin as plugin, diff --git a/plugins/graphiql/src/index.ts b/plugins/graphiql/src/index.ts index e4d8a32a05..15568b4cf8 100644 --- a/plugins/graphiql/src/index.ts +++ b/plugins/graphiql/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * Backstage plugin for browsing GraphQL APIs + * + * @packageDocumentation + */ + import GraphiQLIconComponent from './assets/graphiql.icon.svg'; import { IconComponent } from '@backstage/core-plugin-api'; diff --git a/plugins/graphql/api-report.md b/plugins/graphql/api-report.md index c09feb7bcc..e6f292c20a 100644 --- a/plugins/graphql/api-report.md +++ b/plugins/graphql/api-report.md @@ -21,6 +21,4 @@ export interface RouterOptions { // (undocumented) logger: Logger_2; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/graphql/src/index.ts b/plugins/graphql/src/index.ts index ca73cb27ba..a9f7f92ad9 100644 --- a/plugins/graphql/src/index.ts +++ b/plugins/graphql/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * An experimental Backstage backend plugin for GraphQL + * + * @packageDocumentation + */ + export * from './service/router'; diff --git a/plugins/home/api-report.md b/plugins/home/api-report.md index 66b6e55306..db7631290d 100644 --- a/plugins/home/api-report.md +++ b/plugins/home/api-report.md @@ -125,6 +125,4 @@ export const SettingsModal: ({ // Warnings were encountered during analysis: // // src/extensions.d.ts:16:5 - (ae-forgotten-export) The symbol "ComponentParts" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/home/src/index.ts b/plugins/home/src/index.ts index 0c7cc2c09f..0dacda7a01 100644 --- a/plugins/home/src/index.ts +++ b/plugins/home/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that helps you build a home page + * + * @packageDocumentation + */ + export { homePlugin, HomepageCompositionRoot, diff --git a/plugins/ilert/src/index.ts b/plugins/ilert/src/index.ts index c28153c27e..9a3119516f 100644 --- a/plugins/ilert/src/index.ts +++ b/plugins/ilert/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards iLert + * + * @packageDocumentation + */ + import ILertIconComponent from './assets/ilert.icon.svg'; import { IconComponent } from '@backstage/core-plugin-api'; diff --git a/plugins/jenkins-backend/api-report.md b/plugins/jenkins-backend/api-report.md index 01114e74d6..c909c54806 100644 --- a/plugins/jenkins-backend/api-report.md +++ b/plugins/jenkins-backend/api-report.md @@ -91,6 +91,4 @@ export interface RouterOptions { // (undocumented) logger: Logger_2; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/jenkins-backend/src/index.ts b/plugins/jenkins-backend/src/index.ts index c5c541db2b..c55335c52d 100644 --- a/plugins/jenkins-backend/src/index.ts +++ b/plugins/jenkins-backend/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that integrates towards Jenkins + * + * @packageDocumentation + */ + export * from './service'; diff --git a/plugins/jenkins/api-report.md b/plugins/jenkins/api-report.md index 5a50c14f87..f33e565d89 100644 --- a/plugins/jenkins/api-report.md +++ b/plugins/jenkins/api-report.md @@ -153,6 +153,4 @@ export const LEGACY_JENKINS_ANNOTATION = 'jenkins.io/github-folder'; // // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/jenkins/src/index.ts b/plugins/jenkins/src/index.ts index 2f11e03f3f..7562026bdc 100644 --- a/plugins/jenkins/src/index.ts +++ b/plugins/jenkins/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Jenkins + * + * @packageDocumentation + */ + export { jenkinsPlugin, jenkinsPlugin as plugin, diff --git a/plugins/kafka-backend/api-report.md b/plugins/kafka-backend/api-report.md index 4065244e6a..26a3a44ee4 100644 --- a/plugins/kafka-backend/api-report.md +++ b/plugins/kafka-backend/api-report.md @@ -12,6 +12,4 @@ import { Logger as Logger_2 } from 'winston'; // // @public (undocumented) export function createRouter(options: RouterOptions): Promise; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kafka-backend/src/index.ts b/plugins/kafka-backend/src/index.ts index c73d918ca5..ab1026e99d 100644 --- a/plugins/kafka-backend/src/index.ts +++ b/plugins/kafka-backend/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that integrates towards Kafka + * + * @packageDocumentation + */ + export { createRouter } from './service/router'; diff --git a/plugins/kafka/api-report.md b/plugins/kafka/api-report.md index 6bc169dd24..0750978b27 100644 --- a/plugins/kafka/api-report.md +++ b/plugins/kafka/api-report.md @@ -46,6 +46,4 @@ export { kafkaPlugin as plugin }; // // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kafka/src/index.ts b/plugins/kafka/src/index.ts index abb8b8bdc8..0c15269e7b 100644 --- a/plugins/kafka/src/index.ts +++ b/plugins/kafka/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards Kafka + * + * @packageDocumentation + */ + export { kafkaPlugin, kafkaPlugin as plugin, diff --git a/plugins/kubernetes-backend/api-report.md b/plugins/kubernetes-backend/api-report.md index f69977f5ad..60e8444003 100644 --- a/plugins/kubernetes-backend/api-report.md +++ b/plugins/kubernetes-backend/api-report.md @@ -163,6 +163,4 @@ export interface ServiceAccountClusterDetails extends ClusterDetails {} // // @public (undocumented) export type ServiceLocatorMethod = 'multiTenant' | 'http'; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes-backend/src/index.ts b/plugins/kubernetes-backend/src/index.ts index e5eb5e7c62..29818f805c 100644 --- a/plugins/kubernetes-backend/src/index.ts +++ b/plugins/kubernetes-backend/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that integrates towards Kubernetes + * + * @packageDocumentation + */ + export * from './service/router'; export * from './types/types'; diff --git a/plugins/kubernetes-common/api-report.md b/plugins/kubernetes-common/api-report.md index 04f54b1f1a..82504d4e16 100644 --- a/plugins/kubernetes-common/api-report.md +++ b/plugins/kubernetes-common/api-report.md @@ -164,6 +164,4 @@ export interface ServiceFetchResponse { // (undocumented) type: 'services'; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes-common/src/index.ts b/plugins/kubernetes-common/src/index.ts index 1bd5b2ec4e..af146ae9fa 100644 --- a/plugins/kubernetes-common/src/index.ts +++ b/plugins/kubernetes-common/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin + * + * @packageDocumentation + */ + export * from './types'; diff --git a/plugins/kubernetes/api-report.md b/plugins/kubernetes/api-report.md index 0a3b466942..e3f00c49eb 100644 --- a/plugins/kubernetes/api-report.md +++ b/plugins/kubernetes/api-report.md @@ -54,6 +54,4 @@ export { kubernetesPlugin as plugin }; // // @public (undocumented) export const Router: (_props: Props) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/kubernetes/src/index.ts b/plugins/kubernetes/src/index.ts index 23acc3e7ca..6751594b30 100644 --- a/plugins/kubernetes/src/index.ts +++ b/plugins/kubernetes/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards Kubernetes + * + * @packageDocumentation + */ + export { kubernetesPlugin, kubernetesPlugin as plugin, diff --git a/plugins/lighthouse/api-report.md b/plugins/lighthouse/api-report.md index dca8f80471..724f8898a6 100644 --- a/plugins/lighthouse/api-report.md +++ b/plugins/lighthouse/api-report.md @@ -241,6 +241,4 @@ export interface Website { // // @public (undocumented) export type WebsiteListResponse = LASListResponse; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/lighthouse/src/index.ts b/plugins/lighthouse/src/index.ts index 55372a69dc..acba952f4d 100644 --- a/plugins/lighthouse/src/index.ts +++ b/plugins/lighthouse/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Lighthouse + * + * @packageDocumentation + */ + export { lighthousePlugin, lighthousePlugin as plugin, diff --git a/plugins/newrelic/api-report.md b/plugins/newrelic/api-report.md index 94c3278df1..43beb3807f 100644 --- a/plugins/newrelic/api-report.md +++ b/plugins/newrelic/api-report.md @@ -24,6 +24,4 @@ const newRelicPlugin: BackstagePlugin< >; export { newRelicPlugin }; export { newRelicPlugin as plugin }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/newrelic/src/index.ts b/plugins/newrelic/src/index.ts index cd2b54a556..20183d22a0 100644 --- a/plugins/newrelic/src/index.ts +++ b/plugins/newrelic/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards New Relic + * + * @packageDocumentation + */ + export { newRelicPlugin, newRelicPlugin as plugin, diff --git a/plugins/org/api-report.md b/plugins/org/api-report.md index 78a2f82561..88ce00fd52 100644 --- a/plugins/org/api-report.md +++ b/plugins/org/api-report.md @@ -89,6 +89,4 @@ export const UserProfileCard: ({ entity?: UserEntity | undefined; variant?: InfoCardVariants | undefined; }) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/org/src/index.ts b/plugins/org/src/index.ts index 30e8c9d293..33671697d6 100644 --- a/plugins/org/src/index.ts +++ b/plugins/org/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that helps you create entity pages for your organization + * + * @packageDocumentation + */ + export { orgPlugin, orgPlugin as plugin, diff --git a/plugins/pagerduty/api-report.md b/plugins/pagerduty/api-report.md index 0740b440ee..55e3115102 100644 --- a/plugins/pagerduty/api-report.md +++ b/plugins/pagerduty/api-report.md @@ -88,6 +88,4 @@ export function TriggerButton({ // // @public (undocumented) export class UnauthorizedError extends Error {} - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/pagerduty/src/index.ts b/plugins/pagerduty/src/index.ts index e404e7cedf..8c970c01bb 100644 --- a/plugins/pagerduty/src/index.ts +++ b/plugins/pagerduty/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards PagerDuty + * + * @packageDocumentation + */ + export { pagerDutyPlugin, pagerDutyPlugin as plugin, diff --git a/plugins/proxy-backend/api-report.md b/plugins/proxy-backend/api-report.md index eb7fbec12e..b71783cabf 100644 --- a/plugins/proxy-backend/api-report.md +++ b/plugins/proxy-backend/api-report.md @@ -13,6 +13,4 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common'; // // @public (undocumented) export function createRouter(options: RouterOptions): Promise; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/proxy-backend/src/index.ts b/plugins/proxy-backend/src/index.ts index c5c541db2b..8f5d5c79dc 100644 --- a/plugins/proxy-backend/src/index.ts +++ b/plugins/proxy-backend/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that helps you set up proxy endpoints in the backend + * + * @packageDocumentation + */ + export * from './service'; diff --git a/plugins/rollbar-backend/api-report.md b/plugins/rollbar-backend/api-report.md index 6ac27447d8..0fa4383564 100644 --- a/plugins/rollbar-backend/api-report.md +++ b/plugins/rollbar-backend/api-report.md @@ -77,6 +77,4 @@ export interface RouterOptions { // (undocumented) rollbarApi?: RollbarApi; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/rollbar-backend/src/index.ts b/plugins/rollbar-backend/src/index.ts index a2014db012..883ae8034d 100644 --- a/plugins/rollbar-backend/src/index.ts +++ b/plugins/rollbar-backend/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that integrates towards Rollbar + * + * @packageDocumentation + */ + export * from './api'; export * from './service/router'; diff --git a/plugins/rollbar/api-report.md b/plugins/rollbar/api-report.md index 4009702da4..fbdbd36208 100644 --- a/plugins/rollbar/api-report.md +++ b/plugins/rollbar/api-report.md @@ -104,6 +104,4 @@ export { rollbarPlugin }; // // @public (undocumented) export const Router: (_props: Props_2) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/rollbar/src/index.ts b/plugins/rollbar/src/index.ts index ed19a2e709..3964582bd6 100644 --- a/plugins/rollbar/src/index.ts +++ b/plugins/rollbar/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Rollbar + * + * @packageDocumentation + */ + export * from './api'; export { EntityPageRollbar } from './components/EntityPageRollbar/EntityPageRollbar'; export { diff --git a/plugins/scaffolder-backend-module-cookiecutter/api-report.md b/plugins/scaffolder-backend-module-cookiecutter/api-report.md index 8e46667fce..6fa57fd0f3 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/api-report.md +++ b/plugins/scaffolder-backend-module-cookiecutter/api-report.md @@ -18,6 +18,4 @@ export function createFetchCookiecutterAction(options: { integrations: ScmIntegrations; containerRunner: ContainerRunner; }): TemplateAction; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-backend-module-cookiecutter/src/index.ts b/plugins/scaffolder-backend-module-cookiecutter/src/index.ts index 4f06b14a86..cce8011059 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/src/index.ts +++ b/plugins/scaffolder-backend-module-cookiecutter/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A module for the scaffolder backend that lets you template projects using cookiecutter + * + * @packageDocumentation + */ + export * from './actions'; diff --git a/plugins/scaffolder-backend-module-rails/api-report.md b/plugins/scaffolder-backend-module-rails/api-report.md index 7d1576c7f1..477483f70e 100644 --- a/plugins/scaffolder-backend-module-rails/api-report.md +++ b/plugins/scaffolder-backend-module-rails/api-report.md @@ -16,6 +16,4 @@ export function createFetchRailsAction(options: { integrations: ScmIntegrations; containerRunner: ContainerRunner; }): TemplateAction; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-backend-module-rails/src/index.ts b/plugins/scaffolder-backend-module-rails/src/index.ts index 4f06b14a86..eb51c06c49 100644 --- a/plugins/scaffolder-backend-module-rails/src/index.ts +++ b/plugins/scaffolder-backend-module-rails/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A module for the scaffolder backend that lets you template projects using Rails + * + * @packageDocumentation + */ + export * from './actions'; diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index b43adc189a..4a8c103906 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -270,6 +270,4 @@ export class TemplateActionRegistry { action: TemplateAction, ): void; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder-backend/src/index.ts b/plugins/scaffolder-backend/src/index.ts index 1ae4780567..a7ae821463 100644 --- a/plugins/scaffolder-backend/src/index.ts +++ b/plugins/scaffolder-backend/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage backend plugin that helps you create new things + * + * @packageDocumentation + */ + export * from './scaffolder'; export * from './service/router'; export * from './lib/catalog'; diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 8887810a02..949f19a058 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -253,6 +253,4 @@ export const TextValuePicker: ({ idSchema, placeholder, }: FieldProps) => JSX.Element; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts index c0e652b44c..4de701bf7a 100644 --- a/plugins/scaffolder/src/index.ts +++ b/plugins/scaffolder/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage plugin that helps you create new things + * + * @packageDocumentation + */ + export { scaffolderApiRef, ScaffolderClient } from './api'; export type { ScaffolderApi } from './api'; export { diff --git a/plugins/search-backend-module-elasticsearch/api-report.md b/plugins/search-backend-module-elasticsearch/api-report.md index 1644ce65ea..da1f7d4804 100644 --- a/plugins/search-backend-module-elasticsearch/api-report.md +++ b/plugins/search-backend-module-elasticsearch/api-report.md @@ -48,6 +48,4 @@ export class ElasticSearchSearchEngine implements SearchEngine { pageCursor, }: SearchQuery): ConcreteElasticSearchQuery; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-elasticsearch/src/index.ts b/plugins/search-backend-module-elasticsearch/src/index.ts index 4cfeec6598..b4dab93b76 100644 --- a/plugins/search-backend-module-elasticsearch/src/index.ts +++ b/plugins/search-backend-module-elasticsearch/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * A module for the search backend that implements search using ElasticSearch + * + * @packageDocumentation + */ + export { ElasticSearchSearchEngine } from './engines'; diff --git a/plugins/search-backend-module-pg/api-report.md b/plugins/search-backend-module-pg/api-report.md index 6a56daa8d7..7a171127a3 100644 --- a/plugins/search-backend-module-pg/api-report.md +++ b/plugins/search-backend-module-pg/api-report.md @@ -123,6 +123,4 @@ export interface RawDocumentRow { // (undocumented) type: string; } - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-module-pg/src/index.ts b/plugins/search-backend-module-pg/src/index.ts index 7c5716cfc4..fbc52735dd 100644 --- a/plugins/search-backend-module-pg/src/index.ts +++ b/plugins/search-backend-module-pg/src/index.ts @@ -13,5 +13,12 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A module for the search backend that implements search using PostgreSQL + * + * @packageDocumentation + */ + export * from './database'; export * from './PgSearchEngine'; diff --git a/plugins/search-backend-node/api-report.md b/plugins/search-backend-node/api-report.md index beb1234e6a..17887b3fd1 100644 --- a/plugins/search-backend-node/api-report.md +++ b/plugins/search-backend-node/api-report.md @@ -67,6 +67,4 @@ export class Scheduler { } export { SearchEngine }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend-node/src/index.ts b/plugins/search-backend-node/src/index.ts index a0a1109211..d49ef195f2 100644 --- a/plugins/search-backend-node/src/index.ts +++ b/plugins/search-backend-node/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A library for Backstage backend plugins that want to interact with the search backend plugin + * + * @packageDocumentation + */ + export { IndexBuilder } from './IndexBuilder'; export { Scheduler } from './Scheduler'; export { LunrSearchEngine } from './engines'; diff --git a/plugins/search-backend/api-report.md b/plugins/search-backend/api-report.md index 2a7457eb81..f2479610fe 100644 --- a/plugins/search-backend/api-report.md +++ b/plugins/search-backend/api-report.md @@ -15,6 +15,4 @@ export function createRouter({ engine, logger, }: RouterOptions): Promise; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search-backend/src/index.ts b/plugins/search-backend/src/index.ts index f2c8407292..851efd1875 100644 --- a/plugins/search-backend/src/index.ts +++ b/plugins/search-backend/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * The Backstage backend plugin that provides your backstage app with search + * + * @packageDocumentation + */ + export * from './service/router'; diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index bdb2ab2a54..169972d02d 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -184,6 +184,4 @@ export const useSearch: () => SearchContextValue; // src/components/SearchContext/SearchContext.d.ts:21:5 - (ae-forgotten-export) The symbol "SettableSearchContext" needs to be exported by the entry point index.d.ts // src/components/SearchFilter/SearchFilter.d.ts:13:5 - (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // src/components/SearchFilter/SearchFilter.d.ts:14:5 - (ae-forgotten-export) The symbol "Component" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/search/src/index.ts b/plugins/search/src/index.ts index d98d5416cc..07e4443f04 100644 --- a/plugins/search/src/index.ts +++ b/plugins/search/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage plugin that provides your backstage app with search + * + * @packageDocumentation + */ + export { searchApiRef } from './apis'; export { Filters, diff --git a/plugins/sentry/api-report.md b/plugins/sentry/api-report.md index 92ea326f87..7143272284 100644 --- a/plugins/sentry/api-report.md +++ b/plugins/sentry/api-report.md @@ -124,6 +124,4 @@ export { sentryPlugin }; // src/api/sentry-issue.d.ts:21:9 - (ae-forgotten-export) The symbol "EventPoint" needs to be exported by the entry point index.d.ts // src/api/sentry-issue.d.ts:31:5 - (ae-forgotten-export) The symbol "SentryIssueMetadata" needs to be exported by the entry point index.d.ts // src/api/sentry-issue.d.ts:44:5 - (ae-forgotten-export) The symbol "SentryProject" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/sentry/src/index.ts b/plugins/sentry/src/index.ts index cab47bb7db..efb547e1a6 100644 --- a/plugins/sentry/src/index.ts +++ b/plugins/sentry/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that integrates towards Sentry + * + * @packageDocumentation + */ + export * from './api'; export * from './components'; export { sentryPlugin, sentryPlugin as plugin } from './plugin'; diff --git a/plugins/shortcuts/api-report.md b/plugins/shortcuts/api-report.md index 3d6a56244a..0e1442b53f 100644 --- a/plugins/shortcuts/api-report.md +++ b/plugins/shortcuts/api-report.md @@ -62,6 +62,4 @@ export const shortcutsApiRef: ApiRef; // // @public (undocumented) export const shortcutsPlugin: BackstagePlugin<{}, {}>; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/shortcuts/src/index.ts b/plugins/shortcuts/src/index.ts index 13af05e127..40b902798b 100644 --- a/plugins/shortcuts/src/index.ts +++ b/plugins/shortcuts/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that provides a shortcuts feature to the sidebar + * + * @packageDocumentation + */ + export { shortcutsPlugin, Shortcuts } from './plugin'; export * from './api'; export type { Shortcut } from './types'; diff --git a/plugins/splunk-on-call/api-report.md b/plugins/splunk-on-call/api-report.md index 02ebcc324f..19f60ffd13 100644 --- a/plugins/splunk-on-call/api-report.md +++ b/plugins/splunk-on-call/api-report.md @@ -104,6 +104,4 @@ export class UnauthorizedError extends Error {} // Warnings were encountered during analysis: // // src/plugin.d.ts:7:5 - (ae-forgotten-export) The symbol "SplunkOnCallPageProps" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/splunk-on-call/src/index.ts b/plugins/splunk-on-call/src/index.ts index 4aa85b51c9..917106504b 100644 --- a/plugins/splunk-on-call/src/index.ts +++ b/plugins/splunk-on-call/src/index.ts @@ -13,6 +13,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that integrates towards Splunk On-Call + * + * @packageDocumentation + */ + export { EntitySplunkOnCallCard, splunkOnCallPlugin, diff --git a/plugins/tech-radar/api-report.md b/plugins/tech-radar/api-report.md index c93c10cb47..c02c7ee519 100644 --- a/plugins/tech-radar/api-report.md +++ b/plugins/tech-radar/api-report.md @@ -151,6 +151,4 @@ export { techRadarPlugin }; // Warnings were encountered during analysis: // // src/components/RadarPage.d.ts:9:5 - (ae-forgotten-export) The symbol "TechRadarPageProps" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/tech-radar/src/index.ts b/plugins/tech-radar/src/index.ts index 9d44b2e688..a2bbb95c2b 100644 --- a/plugins/tech-radar/src/index.ts +++ b/plugins/tech-radar/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that lets you display a Tech Radar for your organization + * + * @packageDocumentation + */ + export { techRadarPlugin, techRadarPlugin as plugin, diff --git a/plugins/techdocs-backend/api-report.md b/plugins/techdocs-backend/api-report.md index 4190b3e67c..eaa8a4dda0 100644 --- a/plugins/techdocs-backend/api-report.md +++ b/plugins/techdocs-backend/api-report.md @@ -56,6 +56,4 @@ export class DefaultTechDocsCollator implements DocumentCollator { export { TechDocsDocument }; export * from '@backstage/techdocs-common'; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs-backend/src/index.ts b/plugins/techdocs-backend/src/index.ts index e2a89237db..69a30bf2b0 100644 --- a/plugins/techdocs-backend/src/index.ts +++ b/plugins/techdocs-backend/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage backend plugin that renders technical documentation for your components + * + * @packageDocumentation + */ + export { createRouter } from './service/router'; export * from './search'; export * from '@backstage/techdocs-common'; diff --git a/plugins/techdocs/api-report.md b/plugins/techdocs/api-report.md index b9e776184a..082dfc1db4 100644 --- a/plugins/techdocs/api-report.md +++ b/plugins/techdocs/api-report.md @@ -390,6 +390,4 @@ export class TechDocsStorageClient implements TechDocsStorageApi { // src/home/components/EntityListDocsTable.d.ts:11:5 - (ae-forgotten-export) The symbol "columnFactories" needs to be exported by the entry point index.d.ts // src/home/components/EntityListDocsTable.d.ts:12:5 - (ae-forgotten-export) The symbol "actionFactories" needs to be exported by the entry point index.d.ts // src/plugin.d.ts:29:5 - (ae-forgotten-export) The symbol "TabsConfig" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/techdocs/src/index.ts b/plugins/techdocs/src/index.ts index 4ebf29180c..ba24f1c39d 100644 --- a/plugins/techdocs/src/index.ts +++ b/plugins/techdocs/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * The Backstage plugin that renders technical documentation for your components + * + * @packageDocumentation + */ + export * from './api'; export { techdocsApiRef, techdocsStorageApiRef } from './api'; export type { TechDocsApi, TechDocsStorageApi } from './api'; diff --git a/plugins/todo-backend/api-report.md b/plugins/todo-backend/api-report.md index 592a912c11..f989755a62 100644 --- a/plugins/todo-backend/api-report.md +++ b/plugins/todo-backend/api-report.md @@ -131,6 +131,4 @@ export interface TodoService { // Warnings were encountered during analysis: // // src/service/types.d.ts:9:9 - (ae-forgotten-export) The symbol "Fields" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/todo-backend/src/index.ts b/plugins/todo-backend/src/index.ts index a34294c015..973c91df44 100644 --- a/plugins/todo-backend/src/index.ts +++ b/plugins/todo-backend/src/index.ts @@ -14,5 +14,11 @@ * limitations under the License. */ +/** + * A Backstage backend plugin that lets you browse TODO comments in your source code + * + * @packageDocumentation + */ + export * from './lib'; export * from './service'; diff --git a/plugins/todo/api-report.md b/plugins/todo/api-report.md index 22fca3cb9e..e0fdb8ba58 100644 --- a/plugins/todo/api-report.md +++ b/plugins/todo/api-report.md @@ -86,6 +86,4 @@ export type TodoListResult = { // @public export const todoPlugin: BackstagePlugin<{}, {}>; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/todo/src/index.ts b/plugins/todo/src/index.ts index 92a85945ac..3cd8d1f5c1 100644 --- a/plugins/todo/src/index.ts +++ b/plugins/todo/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that lets you browse TODO comments in your source code + * + * @packageDocumentation + */ + export { todoApiRef, TodoClient } from './api'; export type { TodoApi, diff --git a/plugins/user-settings/api-report.md b/plugins/user-settings/api-report.md index af542e22d9..653e85a541 100644 --- a/plugins/user-settings/api-report.md +++ b/plugins/user-settings/api-report.md @@ -119,6 +119,4 @@ export const useUserProfile: () => { profile: ProfileInfo; displayName: string; }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/user-settings/src/index.ts b/plugins/user-settings/src/index.ts index a0fd7333c9..0654b7fced 100644 --- a/plugins/user-settings/src/index.ts +++ b/plugins/user-settings/src/index.ts @@ -14,6 +14,12 @@ * limitations under the License. */ +/** + * A Backstage plugin that provides a settings page + * + * @packageDocumentation + */ + export { userSettingsPlugin, userSettingsPlugin as plugin, diff --git a/plugins/welcome/api-report.md b/plugins/welcome/api-report.md index f3096482de..02a46615f3 100644 --- a/plugins/welcome/api-report.md +++ b/plugins/welcome/api-report.md @@ -18,6 +18,4 @@ export const WelcomePage: () => JSX.Element; const welcomePlugin: BackstagePlugin<{}, {}>; export { welcomePlugin as plugin }; export { welcomePlugin }; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/welcome/src/index.ts b/plugins/welcome/src/index.ts index d88b45b721..df8f99b6ed 100644 --- a/plugins/welcome/src/index.ts +++ b/plugins/welcome/src/index.ts @@ -14,4 +14,10 @@ * limitations under the License. */ +/** + * An old Backstage plugin that provides a welcome page + * + * @packageDocumentation + */ + export { welcomePlugin, welcomePlugin as plugin, WelcomePage } from './plugin'; diff --git a/plugins/xcmetrics/api-report.md b/plugins/xcmetrics/api-report.md index 9eb9a16f8b..3e2aa23451 100644 --- a/plugins/xcmetrics/api-report.md +++ b/plugins/xcmetrics/api-report.md @@ -22,6 +22,4 @@ export const xcmetricsPlugin: BackstagePlugin< }, {} >; - -// (No @packageDocumentation comment for this package) ``` diff --git a/plugins/xcmetrics/src/index.ts b/plugins/xcmetrics/src/index.ts index aa02224738..fc0bb0e55a 100644 --- a/plugins/xcmetrics/src/index.ts +++ b/plugins/xcmetrics/src/index.ts @@ -13,4 +13,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * A Backstage plugin that shows XCode build metrics for your components + * + * @packageDocumentation + */ + export { xcmetricsPlugin, XcmetricsPage } from './plugin'; From b8310ae106d94f8e361d0217b0cdca33db5b2640 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 14 Sep 2021 18:59:38 +0200 Subject: [PATCH 4/5] api-extractor: separate tables for packages and plugins Signed-off-by: Patrik Oldsberg --- scripts/api-extractor.ts | 54 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index 6b34b4a82b..fa85f1bcad 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -37,6 +37,9 @@ import { IMarkdownDocumenterOptions, MarkdownDocumenter, } from '@microsoft/api-documenter/lib/documenters/MarkdownDocumenter'; +import { DocTable } from '@microsoft/api-documenter/lib/nodes/DocTable'; +import { DocTableRow } from '@microsoft/api-documenter/lib/nodes/DocTableRow'; +import { DocHeading } from '@microsoft/api-documenter/lib/nodes/DocHeading'; import { CustomMarkdownEmitter } from '@microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter'; import { IMarkdownEmitterContext } from '@microsoft/api-documenter/lib/markdown/MarkdownEmitter'; @@ -463,6 +466,57 @@ async function buildDocs({ output.appendNode = oldAppendNode; }; } + + _writeModelTable(output, apiModel): void { + const configuration = this._tsdocConfiguration; + + const packagesTable = new DocTable({ + configuration, + headerTitles: ['Package', 'Description'], + }); + + const pluginsTable = new DocTable({ + configuration, + headerTitles: ['Package', 'Description'], + }); + + for (const apiMember of apiModel.members) { + const row = new DocTableRow({ configuration }, [ + this._createTitleCell(apiMember), + this._createDescriptionCell(apiMember), + ]); + + if (apiMember.kind === 'Package') { + this._writeApiItemPage(apiMember); + + if (apiMember.name.startsWith('@backstage/plugin-')) { + pluginsTable.addRow(row); + } else { + packagesTable.addRow(row); + } + } + } + + if (packagesTable.rows.length > 0) { + output.appendNode( + new DocHeading({ + configuration: this._tsdocConfiguration, + title: 'Packages', + }), + ); + output.appendNode(packagesTable); + } + + if (pluginsTable.rows.length > 0) { + output.appendNode( + new DocHeading({ + configuration: this._tsdocConfiguration, + title: 'Plugins', + }), + ); + output.appendNode(pluginsTable); + } + } } // This is root of the documentation generation, but it's not directly From c12459d93e7e88c2c49a04584ce20e388eea8576 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 14 Sep 2021 19:34:28 +0200 Subject: [PATCH 5/5] api-extractor: tweak front matter handling Signed-off-by: Patrik Oldsberg --- scripts/api-extractor.ts | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index fa85f1bcad..8596d43a8d 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -352,21 +352,15 @@ async function buildDocs({ class DocFrontMatter extends DocNode { static kind = 'DocFrontMatter'; - public readonly id: string; - public readonly title: string; - public readonly description: string; + public readonly values: { [name: string]: unknown }; public constructor( parameters: IDocNodeContainerParameters & { - id: string; - title: string; - description: string; + values: { [name: string]: unknown }; }, ) { super(parameters); - this.id = parameters.id; - this.title = parameters.title; - this.description = parameters.description; + this.values = parameters.values; } /** @override */ @@ -388,9 +382,11 @@ async function buildDocs({ case DocFrontMatter.kind: { const node = docNode as DocFrontMatter; context.writer.writeLine('---'); - context.writer.writeLine(`id: ${node.id}`); - context.writer.writeLine(`title: ${node.title}`); - context.writer.writeLine(`description: ${node.description}`); + for (const [name, value] of Object.entries(node.values)) { + if (value) { + context.writer.writeLine(`${name}: ${value}`); + } + } context.writer.writeLine('---'); context.writer.writeLine(); break; @@ -450,9 +446,11 @@ async function buildDocs({ output.appendNodeInParagraph( new DocFrontMatter({ configuration: this._tsdocConfiguration, - id: this._getFilenameForApiItem(apiItem).slice(0, -3), - title, - description, + values: { + id: this._getFilenameForApiItem(apiItem).slice(0, -3), + title, + description, + }, }), );