packages,plugins: add package documentation

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/backend-common/api-report.md

@@ -574,6 +574,4 @@ export function useHotCleanup(
 
 // @public
 export function useHotMemoize<T>(_module: NodeModule, valueFactory: () => T): T;
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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';

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)
 ```

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';

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)
 ```

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';

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)
 ```

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';

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';

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';

packages/config-loader/api-report.md

@@ -73,6 +73,4 @@ export type TransformFunc<T extends number | string | boolean> = (
     visibility: ConfigVisibility;
   },
 ) => T | undefined;
-
-// (No @packageDocumentation comment for this package)
 ```

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,

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)
 ```

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,

packages/core-app-api/api-report.md

@@ -187,10 +187,9 @@ export type AppContext = {
 // @public (undocumented)
 export type AppOptions = {
   apis?: Iterable<AnyApiFactory>;
-  icons?: Partial<AppIcons> &
-    {
-      [key in string]: IconComponent;
-    };
+  icons?: Partial<AppIcons> & {
+    [key in string]: IconComponent;
+  };
   plugins?: BackstagePluginWithAnyOutput[];
   components?: Partial<AppComponents>;
   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)
 ```

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';

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)
 ```

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';

packages/core-plugin-api/api-report.md

@@ -903,6 +903,4 @@ export function withApis<T>(apis: TypesToApiRefs<T>): <P extends T>(
 // 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)
 ```

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';

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';

packages/dev-utils/api-report.md

@@ -51,6 +51,4 @@ export const EntityGridItem: ({
 }: Omit<GridProps<'div', {}>, 'container' | 'item'> & {
   entity: Entity;
 }) => JSX.Element;
-
-// (No @packageDocumentation comment for this package)
 ```

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';

packages/errors/api-report.md

@@ -79,6 +79,4 @@ export function serializeError(
     includeStack?: boolean;
   },
 ): SerializedError;
-
-// (No @packageDocumentation comment for this package)
 ```

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';

packages/integration-react/api-report.md

@@ -30,6 +30,4 @@ export class ScmIntegrationsApi {
 //
 // @public (undocumented)
 export const scmIntegrationsApiRef: ApiRef<ScmIntegrationRegistry>;
-
-// (No @packageDocumentation comment for this package)
 ```

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';

packages/integration/api-report.md

@@ -537,6 +537,4 @@ export interface ScmIntegrationsGroup<T extends ScmIntegration> {
 // 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)
 ```

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';

packages/search-common/api-report.md

@@ -81,6 +81,4 @@ export interface SearchResultSet {
   // (undocumented)
   results: SearchResult[];
 }
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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';

packages/test-utils-core/api-report.md

@@ -112,6 +112,4 @@ export function withLogCollector<T extends LogFuncs>(
   logsToCollect: T[],
   callback: SyncLogCollector,
 ): CollectedLogs<T>;
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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';

packages/theme/api-report.md

@@ -116,6 +116,4 @@ export type SimpleThemeOptions = {
   pageTheme?: Record<string, PageTheme>;
   fontFamily?: string;
 };
-
-// (No @packageDocumentation comment for this package)
 ```

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';

packages/version-bridge/api-report.md

@@ -45,6 +45,4 @@ export type VersionedValue<
     version: Version,
   ): Versions[Version] | undefined;
 };
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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';

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)
 ```

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 {

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)
 ```

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';

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)
 ```

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';

plugins/badges-backend/api-report.md

@@ -139,6 +139,4 @@ export interface RouterOptions {
   // (undocumented)
   discovery: PluginEndpointDiscovery;
 }
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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';

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)
 ```

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';

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)
 ```

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';

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)
 ```

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';

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)
 ```

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';

plugins/catalog-graphql/api-report.md

@@ -21,6 +21,4 @@ export interface ModuleOptions {
   // (undocumented)
   logger: Logger_2;
 }
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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,

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)
 ```

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';

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)
 ```

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';

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)
 ```

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,

plugins/cloudbuild/api-report.md

@@ -361,6 +361,4 @@ export interface Volume {
   // (undocumented)
   path: string;
 }
-
-// (No @packageDocumentation comment for this package)
 ```

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,

plugins/code-coverage-backend/api-report.md

@@ -43,6 +43,4 @@ export interface RouterOptions {
   // (undocumented)
   urlReader: UrlReader;
 }
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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,

plugins/config-schema/api-report.md

@@ -49,6 +49,4 @@ export class StaticSchemaLoader implements ConfigSchemaApi {
   // (undocumented)
   schema$(): Observable<ConfigSchemaResult>;
 }
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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,

plugins/explore-react/api-report.md

@@ -29,6 +29,4 @@ export interface ExploreToolsConfig {
 //
 // @public (undocumented)
 export const exploreToolsConfigRef: ApiRef<ExploreToolsConfig>;
-
-// (No @packageDocumentation comment for this package)
 ```

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';

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)
 ```

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';

plugins/firehydrant/api-report.md

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

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';

plugins/fossa/api-report.md

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

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';

plugins/gcp-projects/api-report.md

@@ -99,6 +99,4 @@ export type Status = {
   message: string;
   details: string[];
 };
-
-// (No @packageDocumentation comment for this package)
 ```

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,

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
 ```

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,

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)
 ```

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,

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)
 ```

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';

plugins/gitops-profiles/api-report.md

@@ -230,6 +230,4 @@ export interface StatusResponse {
   // (undocumented)
   status: string;
 }
-
-// (No @packageDocumentation comment for this package)
 ```