Use @backstage/plugin-techdocs-node instead of @backstage/techdocs-common

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-03-03 13:33:47 +01:00
parent 84a8788794
commit 91bf1e6c1a
34 changed files with 54 additions and 47 deletions
+1 -1
View File
@@ -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
+5 -5
View File
@@ -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';
```
+1 -1
View File
@@ -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",
@@ -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';
+3 -3
View File
@@ -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';
@@ -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;
@@ -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';
@@ -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';
@@ -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';
@@ -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';
@@ -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';
@@ -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';