diff --git a/.changeset/techdocs-node-one.md b/.changeset/techdocs-node-one.md new file mode 100644 index 0000000000..706c708c4a --- /dev/null +++ b/.changeset/techdocs-node-one.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-techdocs-backend': patch +'@techdocs/cli': patch +--- + +Use `@backstage/plugin-techdocs-node` package instead of `@backstage/techdocs-common`. diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 1a0f827fb1..44c61f9348 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -46,7 +46,7 @@ /plugins/search-* @backstage/reviewers @backstage/techdocs-core /plugins/sonarqube @backstage/reviewers @backstage/sda-se-reviewers /plugins/techdocs @backstage/reviewers @backstage/techdocs-core -/plugins/techdocs-backend @backstage/reviewers @backstage/techdocs-core +/plugins/techdocs-* @backstage/reviewers @backstage/techdocs-core /tech-insights-backend @backstage/reviewers @xantier @iain-b /tech-insights-backend-module-jsonfc @backstage/reviewers @xantier @iain-b /tech-insights-tech-insights-common @backstage/reviewers @xantier @iain-b diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index 2a11e1181a..6efb83549e 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -97,7 +97,7 @@ techdocs-cli generate Alias: `techdocs-cli build` The generate command uses the -[`@backstage/techdocs-common`](https://github.com/backstage/backstage/tree/master/packages/techdocs-common) +[`@backstage/plugin-techdocs-node`](https://github.com/backstage/backstage/tree/master/plugins/techdocs-node) package from Backstage for consistency. A Backstage app can also generate and publish TechDocs sites if `techdocs.builder` is set to `'local'` in `app-config.yaml`. See diff --git a/docs/getting-started/project-structure.md b/docs/getting-started/project-structure.md index 6c49c798d0..b67e847272 100644 --- a/docs/getting-started/project-structure.md +++ b/docs/getting-started/project-structure.md @@ -160,8 +160,8 @@ are separated out into their own folder, see further down. reusable React components. Stories are within the core package, and are published in the [Backstage Storybook](https://backstage.io/storybook). -- [`techdocs-common/`](https://github.com/backstage/backstage/tree/master/packages/techdocs-common) - - Common functionalities for TechDocs, to be shared between +- [`techdocs-node/`](https://github.com/backstage/backstage/tree/master/plugins/techdocs-node) - + Common node.js functionalities for TechDocs, to be shared between [techdocs-backend](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend) plugin and [techdocs-cli](https://github.com/backstage/techdocs-cli). diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json index 32eb70602c..e6cfab0916 100644 --- a/packages/techdocs-cli/package.json +++ b/packages/techdocs-cli/package.json @@ -66,7 +66,7 @@ "@backstage/catalog-model": "^0.12.0", "@backstage/cli-common": "^0.1.8", "@backstage/config": "^0.1.15", - "@backstage/techdocs-common": "^0.11.11", + "@backstage/plugin-techdocs-node": "^0.11.11", "@types/dockerode": "^3.3.0", "commander": "^6.1.0", "dockerode": "^3.3.1", diff --git a/packages/techdocs-cli/src/commands/generate/generate.ts b/packages/techdocs-cli/src/commands/generate/generate.ts index 0f5213df34..98529698ca 100644 --- a/packages/techdocs-cli/src/commands/generate/generate.ts +++ b/packages/techdocs-cli/src/commands/generate/generate.ts @@ -21,7 +21,7 @@ import Docker from 'dockerode'; import { TechdocsGenerator, ParsedLocationAnnotation, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import { DockerContainerRunner } from '@backstage/backend-common'; import { ConfigReader } from '@backstage/config'; import { @@ -31,7 +31,7 @@ import { import { stdout } from 'process'; export default async function generate(cmd: Command) { - // Use techdocs-common package to generate docs. Keep consistency between Backstage and CI generating docs. + // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs. // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow // will run on the CI pipeline containing the documentation files. @@ -78,7 +78,7 @@ export default async function generate(cmd: Command) { } } - // Generate docs using @backstage/techdocs-common + // Generate docs using @backstage/plugin-techdocs-node const techdocsGenerator = await TechdocsGenerator.fromConfig(config, { logger, containerRunner, diff --git a/packages/techdocs-cli/src/commands/index.ts b/packages/techdocs-cli/src/commands/index.ts index 6f1d9847e1..6ad62c5668 100644 --- a/packages/techdocs-cli/src/commands/index.ts +++ b/packages/techdocs-cli/src/commands/index.ts @@ -15,7 +15,7 @@ */ import { CommanderStatic } from 'commander'; -import { TechdocsGenerator } from '@backstage/techdocs-common'; +import { TechdocsGenerator } from '@backstage/plugin-techdocs-node'; const defaultDockerImage = TechdocsGenerator.defaultDockerImage; diff --git a/packages/techdocs-cli/src/commands/migrate/migrate.ts b/packages/techdocs-cli/src/commands/migrate/migrate.ts index 1cd8fca65b..067bf1f173 100644 --- a/packages/techdocs-cli/src/commands/migrate/migrate.ts +++ b/packages/techdocs-cli/src/commands/migrate/migrate.ts @@ -15,7 +15,7 @@ */ import { SingleHostDiscovery } from '@backstage/backend-common'; -import { Publisher } from '@backstage/techdocs-common'; +import { Publisher } from '@backstage/plugin-techdocs-node'; import { Command } from 'commander'; import { createLogger } from '../../lib/utility'; import { PublisherConfig } from '../../lib/PublisherConfig'; diff --git a/packages/techdocs-cli/src/commands/publish/publish.ts b/packages/techdocs-cli/src/commands/publish/publish.ts index 11a47d4a71..c84180b032 100644 --- a/packages/techdocs-cli/src/commands/publish/publish.ts +++ b/packages/techdocs-cli/src/commands/publish/publish.ts @@ -18,7 +18,7 @@ import { resolve } from 'path'; import { Command } from 'commander'; import { createLogger } from '../../lib/utility'; import { SingleHostDiscovery } from '@backstage/backend-common'; -import { Publisher } from '@backstage/techdocs-common'; +import { Publisher } from '@backstage/plugin-techdocs-node'; import { Entity } from '@backstage/catalog-model'; import { PublisherConfig } from '../../lib/PublisherConfig'; diff --git a/packages/techdocs-cli/src/lib/utility.ts b/packages/techdocs-cli/src/lib/utility.ts index 87dbbfd08d..3f91f3c82d 100644 --- a/packages/techdocs-cli/src/lib/utility.ts +++ b/packages/techdocs-cli/src/lib/utility.ts @@ -16,7 +16,7 @@ import { RemoteProtocol, ParsedLocationAnnotation, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import * as winston from 'winston'; export const convertTechDocsRefToLocationAnnotation = ( diff --git a/plugins/techdocs-backend/README.md b/plugins/techdocs-backend/README.md index 57bc477f12..a1d7d22855 100644 --- a/plugins/techdocs-backend/README.md +++ b/plugins/techdocs-backend/README.md @@ -21,7 +21,7 @@ yarn start This provides serving and building of documentation for any entity. To configure various storage providers and building options, see http://backstage.io/docs/features/techdocs/configuration. -The techdocs-backend re-exports the [techdocs-common](https://github.com/backstage/backstage/tree/master/packages/techdocs-common) package which has the features to prepare, generate and publish docs. +The techdocs-backend re-exports the [techdocs-node](https://github.com/backstage/backstage/tree/master/plugins/techdocs-node) package which has the features to prepare, generate and publish docs. The Publishers are also used to fetch the static documentation files and render them in TechDocs. ## Links diff --git a/plugins/techdocs-backend/api-report.md b/plugins/techdocs-backend/api-report.md index 155f096614..acce0b4981 100644 --- a/plugins/techdocs-backend/api-report.md +++ b/plugins/techdocs-backend/api-report.md @@ -10,16 +10,16 @@ import { Config } from '@backstage/config'; import { DocumentCollatorFactory } from '@backstage/search-common'; import { Entity } from '@backstage/catalog-model'; import express from 'express'; -import { GeneratorBuilder } from '@backstage/techdocs-common'; +import { GeneratorBuilder } from '@backstage/plugin-techdocs-node'; import { Knex } from 'knex'; import { Logger as Logger_2 } from 'winston'; import { Permission } from '@backstage/plugin-permission-common'; import { PluginCacheManager } from '@backstage/backend-common'; import { PluginEndpointDiscovery } from '@backstage/backend-common'; -import { PreparerBuilder } from '@backstage/techdocs-common'; -import { PublisherBase } from '@backstage/techdocs-common'; +import { PreparerBuilder } from '@backstage/plugin-techdocs-node'; +import { PublisherBase } from '@backstage/plugin-techdocs-node'; import { Readable } from 'stream'; -import { TechDocsDocument } from '@backstage/techdocs-common'; +import { TechDocsDocument } from '@backstage/plugin-techdocs-node'; import { TokenManager } from '@backstage/backend-common'; // @public @@ -123,5 +123,5 @@ export type TechDocsCollatorOptions = { export { TechDocsDocument }; -export * from '@backstage/techdocs-common'; +export * from '@backstage/plugin-techdocs-node'; ``` diff --git a/plugins/techdocs-backend/package.json b/plugins/techdocs-backend/package.json index 81aa19a937..aea75b1c3d 100644 --- a/plugins/techdocs-backend/package.json +++ b/plugins/techdocs-backend/package.json @@ -41,8 +41,8 @@ "@backstage/errors": "^0.2.2", "@backstage/integration": "^0.8.0", "@backstage/plugin-catalog-common": "^0.2.0", + "@backstage/plugin-techdocs-node": "^0.11.11", "@backstage/search-common": "^0.3.0", - "@backstage/techdocs-common": "^0.11.11", "@types/express": "^4.17.6", "dockerode": "^3.3.1", "express": "^4.17.1", diff --git a/plugins/techdocs-backend/src/DocsBuilder/builder.ts b/plugins/techdocs-backend/src/DocsBuilder/builder.ts index 05e9c0ce52..09eee1fc12 100644 --- a/plugins/techdocs-backend/src/DocsBuilder/builder.ts +++ b/plugins/techdocs-backend/src/DocsBuilder/builder.ts @@ -29,7 +29,7 @@ import { PreparerBuilder, PublisherBase, UrlPreparer, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import fs from 'fs-extra'; import os from 'os'; import path from 'path'; diff --git a/plugins/techdocs-backend/src/index.ts b/plugins/techdocs-backend/src/index.ts index 570da95092..dc5d87d1b3 100644 --- a/plugins/techdocs-backend/src/index.ts +++ b/plugins/techdocs-backend/src/index.ts @@ -39,8 +39,8 @@ export type { } from './search'; /** - * @deprecated Use directly from @backstage/techdocs-common + * @deprecated Use directly from @backstage/plugin-techdocs-node */ -export type { TechDocsDocument } from '@backstage/techdocs-common'; +export type { TechDocsDocument } from '@backstage/plugin-techdocs-node'; -export * from '@backstage/techdocs-common'; +export * from '@backstage/plugin-techdocs-node'; diff --git a/plugins/techdocs-backend/src/search/DefaultTechDocsCollator.ts b/plugins/techdocs-backend/src/search/DefaultTechDocsCollator.ts index d36e1c0ae5..7529eaca66 100644 --- a/plugins/techdocs-backend/src/search/DefaultTechDocsCollator.ts +++ b/plugins/techdocs-backend/src/search/DefaultTechDocsCollator.ts @@ -35,7 +35,7 @@ import { CatalogClient, CATALOG_FILTER_EXISTS, } from '@backstage/catalog-client'; -import { TechDocsDocument } from '@backstage/techdocs-common'; +import { TechDocsDocument } from '@backstage/plugin-techdocs-node'; interface MkSearchIndexDoc { title: string; diff --git a/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts b/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts index 181f032b54..7ba76350e4 100644 --- a/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts +++ b/plugins/techdocs-backend/src/search/DefaultTechDocsCollatorFactory.ts @@ -32,7 +32,7 @@ import { import { Config } from '@backstage/config'; import { catalogEntityReadPermission } from '@backstage/plugin-catalog-common'; import { DocumentCollatorFactory } from '@backstage/search-common'; -import { TechDocsDocument } from '@backstage/techdocs-common'; +import { TechDocsDocument } from '@backstage/plugin-techdocs-node'; import unescape from 'lodash/unescape'; import fetch from 'node-fetch'; import pLimit from 'p-limit'; diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts index 1830dbfcf0..05dfb5bdcc 100644 --- a/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts +++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts @@ -24,7 +24,7 @@ import { GeneratorBuilder, PreparerBuilder, PublisherBase, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import { TechDocsCache } from '../cache'; import { DocsBuilder, shouldCheckForUpdate } from '../DocsBuilder'; import { DocsSynchronizer, DocsSynchronizerSyncOpts } from './DocsSynchronizer'; diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts index 2979d2efe4..090efc4639 100644 --- a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts +++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts @@ -23,7 +23,7 @@ import { GeneratorBuilder, PreparerBuilder, PublisherBase, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import fetch from 'node-fetch'; import { PassThrough } from 'stream'; import * as winston from 'winston'; diff --git a/plugins/techdocs-backend/src/service/router.test.ts b/plugins/techdocs-backend/src/service/router.test.ts index c7cda203bb..2e707c9513 100644 --- a/plugins/techdocs-backend/src/service/router.test.ts +++ b/plugins/techdocs-backend/src/service/router.test.ts @@ -26,7 +26,7 @@ import { GeneratorBuilder, PreparerBuilder, PublisherBase, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import express, { Response } from 'express'; import request from 'supertest'; import { DocsSynchronizer, DocsSynchronizerSyncOpts } from './DocsSynchronizer'; diff --git a/plugins/techdocs-backend/src/service/router.ts b/plugins/techdocs-backend/src/service/router.ts index 73f212d049..9ebad9411d 100644 --- a/plugins/techdocs-backend/src/service/router.ts +++ b/plugins/techdocs-backend/src/service/router.ts @@ -26,7 +26,7 @@ import { getLocationForEntity, PreparerBuilder, PublisherBase, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import express, { Response } from 'express'; import Router from 'express-promise-router'; import { Knex } from 'knex'; diff --git a/plugins/techdocs-backend/src/service/standaloneServer.ts b/plugins/techdocs-backend/src/service/standaloneServer.ts index eeb85bfad0..4ab4c084e0 100644 --- a/plugins/techdocs-backend/src/service/standaloneServer.ts +++ b/plugins/techdocs-backend/src/service/standaloneServer.ts @@ -28,7 +28,7 @@ import { Preparers, Publisher, TechdocsGenerator, -} from '@backstage/techdocs-common'; +} from '@backstage/plugin-techdocs-node'; import Docker from 'dockerode'; import { Server } from 'http'; import { Logger } from 'winston'; diff --git a/plugins/techdocs-node/CHANGELOG.md b/plugins/techdocs-node/CHANGELOG.md index f41c944a89..77f240314b 100644 --- a/plugins/techdocs-node/CHANGELOG.md +++ b/plugins/techdocs-node/CHANGELOG.md @@ -1,4 +1,4 @@ -# @backstage/techdocs-common +# @backstage/plugin-techdocs-node ## 0.11.11 diff --git a/plugins/techdocs-node/README.md b/plugins/techdocs-node/README.md index bbaac85e9b..7bf2e5ba9d 100644 --- a/plugins/techdocs-node/README.md +++ b/plugins/techdocs-node/README.md @@ -1,15 +1,15 @@ -# @backstage/techdocs-common +# @backstage/plugin-techdocs-node -Common functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli +Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli This package is used by `techdocs-backend` to serve docs from different types of publishers (Google GCS, Local, etc.). It is also used to build docs and publish them to storage, by both `techdocs-backend` and `techdocs-cli`. ## Usage -Create a preparer instance from the [preparers available](/packages/techdocs-common/src/stages/prepare) at which takes an Entity instance. -Run the [docs generator](/packages/techdocs-common/src/stages/generate) on the prepared directory. -Publish the generated directory files to a [storage](/packages/techdocs-common/src/stages/publish) of your choice. +Create a preparer instance from the [preparers available](/plugins/techdocs-node/src/stages/prepare) at which takes an Entity instance. +Run the [docs generator](/plugins/techdocs-node/src/stages/generate) on the prepared directory. +Publish the generated directory files to a [storage](/plugins/techdocs-node/src/stages/publish) of your choice. Example: diff --git a/plugins/techdocs-node/api-report.md b/plugins/techdocs-node/api-report.md index 13d610f66b..9ec1aafb09 100644 --- a/plugins/techdocs-node/api-report.md +++ b/plugins/techdocs-node/api-report.md @@ -1,4 +1,4 @@ -## API Report File for "@backstage/techdocs-common" +## API Report File for "@backstage/plugin-techdocs-node" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). diff --git a/plugins/techdocs-node/package.json b/plugins/techdocs-node/package.json index 04e13065c8..7cbf49f954 100644 --- a/plugins/techdocs-node/package.json +++ b/plugins/techdocs-node/package.json @@ -1,6 +1,6 @@ { - "name": "@backstage/techdocs-common", - "description": "Common functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli", + "name": "@backstage/plugin-techdocs-node", + "description": "Common node.js functionalities for TechDocs, to be shared between techdocs-backend plugin and techdocs-cli", "version": "0.11.11", "main": "src/index.ts", "types": "src/index.ts", @@ -17,7 +17,7 @@ "repository": { "type": "git", "url": "https://github.com/backstage/backstage", - "directory": "packages/techdocs-common" + "directory": "plugins/techdocs-node" }, "keywords": [ "techdocs", diff --git a/plugins/techdocs-node/src/stages/generate/techdocs.ts b/plugins/techdocs-node/src/stages/generate/techdocs.ts index b46f52f99a..fd05c3bf8b 100644 --- a/plugins/techdocs-node/src/stages/generate/techdocs.ts +++ b/plugins/techdocs-node/src/stages/generate/techdocs.ts @@ -51,7 +51,7 @@ import { ForwardedError } from '@backstage/errors'; export class TechdocsGenerator implements GeneratorBase { /** * The default docker image (and version) used to generate content. Public - * and static so that techdocs-common consumers can use the same version. + * and static so that techdocs-node consumers can use the same version. */ public static readonly defaultDockerImage = 'spotify/techdocs:v0.3.7'; private readonly logger: Logger; diff --git a/plugins/techdocs-node/src/stages/publish/awsS3.test.ts b/plugins/techdocs-node/src/stages/publish/awsS3.test.ts index 357df73c8c..326e587a83 100644 --- a/plugins/techdocs-node/src/stages/publish/awsS3.test.ts +++ b/plugins/techdocs-node/src/stages/publish/awsS3.test.ts @@ -24,7 +24,7 @@ import path from 'path'; import fs from 'fs-extra'; import { AwsS3Publish } from './awsS3'; -// NOTE: /packages/techdocs-common/__mocks__ is being used to mock aws-sdk client library +// NOTE: /plugins/techdocs-node/__mocks__ is being used to mock aws-sdk client library const rootDir = (global as any).rootDir; // Set by setupTests.ts diff --git a/plugins/techdocs-node/src/stages/publish/azureBlobStorage.test.ts b/plugins/techdocs-node/src/stages/publish/azureBlobStorage.test.ts index f1b660555e..3e5e420e4b 100644 --- a/plugins/techdocs-node/src/stages/publish/azureBlobStorage.test.ts +++ b/plugins/techdocs-node/src/stages/publish/azureBlobStorage.test.ts @@ -24,7 +24,7 @@ import path from 'path'; import fs from 'fs-extra'; import { AzureBlobStoragePublish } from './azureBlobStorage'; -// NOTE: /packages/techdocs-common/__mocks__ is being used to mock Azure client library +// NOTE: /plugins/techdocs-node/__mocks__ is being used to mock Azure client library const rootDir = (global as any).rootDir; // Set by setupTests.ts diff --git a/plugins/techdocs-node/src/stages/publish/googleStorage.test.ts b/plugins/techdocs-node/src/stages/publish/googleStorage.test.ts index 87a38402d0..6dac092cec 100644 --- a/plugins/techdocs-node/src/stages/publish/googleStorage.test.ts +++ b/plugins/techdocs-node/src/stages/publish/googleStorage.test.ts @@ -24,7 +24,7 @@ import path from 'path'; import fs from 'fs-extra'; import { GoogleGCSPublish } from './googleStorage'; -// NOTE: /packages/techdocs-common/__mocks__ is being used to mock Google Cloud Storage client library +// NOTE: /plugins/techdocs-node/__mocks__ is being used to mock Google Cloud Storage client library const rootDir = (global as any).rootDir; // Set by setupTests.ts diff --git a/plugins/techdocs-node/src/stages/publish/local.ts b/plugins/techdocs-node/src/stages/publish/local.ts index af9bb30d46..4539d389df 100644 --- a/plugins/techdocs-node/src/stages/publish/local.ts +++ b/plugins/techdocs-node/src/stages/publish/local.ts @@ -49,7 +49,7 @@ try { ); } catch (err) { // This will most probably never be used. - // The try/catch is introduced so that techdocs-cli can import @backstage/techdocs-common + // The try/catch is introduced so that techdocs-cli can import @backstage/plugin-techdocs-node // on CI/CD without installing techdocs backend plugin. staticDocsDir = os.tmpdir(); } diff --git a/plugins/techdocs-node/src/stages/publish/openStackSwift.test.ts b/plugins/techdocs-node/src/stages/publish/openStackSwift.test.ts index da0a60343f..aeb4e120f5 100644 --- a/plugins/techdocs-node/src/stages/publish/openStackSwift.test.ts +++ b/plugins/techdocs-node/src/stages/publish/openStackSwift.test.ts @@ -29,7 +29,7 @@ import path from 'path'; import { OpenStackSwiftPublish } from './openStackSwift'; import { PublisherBase, TechDocsMetadata } from './types'; -// NOTE: /packages/techdocs-common/__mocks__ is being used to mock @trendyol-js/openstack-swift-sdk client library +// NOTE: /plugins/techdocs-node/__mocks__ is being used to mock @trendyol-js/openstack-swift-sdk client library const createMockEntity = (annotations = {}): Entity => { return { diff --git a/plugins/techdocs-node/src/stages/publish/types.ts b/plugins/techdocs-node/src/stages/publish/types.ts index 86772c25f4..ff5b9acade 100644 --- a/plugins/techdocs-node/src/stages/publish/types.ts +++ b/plugins/techdocs-node/src/stages/publish/types.ts @@ -153,7 +153,7 @@ export interface PublisherBase { * `techdocs-cli` version `{0.x.y}` and `techdocs-backend` version `{0.x.y}`. * * Implementation of this method is unnecessary in publishers introduced - * after version `{0.x.y}` of `techdocs-common`. + * after version `{0.x.y}` of `techdocs-node`. */ migrateDocsCase?(migrateRequest: MigrateRequest): Promise; } diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index afe2c1a1bb..d37fa51c60 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -238,6 +238,7 @@ const NO_WARNING_PACKAGES = [ 'plugins/scaffolder-common', 'plugins/search-backend-node', 'plugins/techdocs-backend', + 'plugins/techdocs-node', 'plugins/tech-insights', 'plugins/tech-insights-backend', 'plugins/tech-insights-backend-module-jsonfc',