Move @backstage/techdocs-addons to @backstage/plugin-techdocs-react

Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Co-authored-by: Anders Näsman <realandersn@users.noreply.github.com>
Signed-off-by: Otto Sichert <git@ottosichert.de>

.changeset/techdocs-hold-me-closer.md

@@ -1,7 +1,9 @@
 ---
-'@backstage/techdocs-addons': minor
+'@backstage/plugin-techdocs-react': minor
 ---
 
-Introducing `@backstage/techdocs-addons`, a web library you can use to create TechDocs addons.
+This package will house frontend utilities related to TechDocs to be shared across other frontend Backstage packages.
+
+In this release, it introduces a framework that can be used create TechDocs addons.
 
 Note: this package is not necessarily stable yet. After iteration on this package, its stability will be signaled by a major-version bump.

.changeset/techdocs-until-you-puke.md

@@ -8,7 +8,7 @@ To customize the standalone TechDocs reader page experience, update your `/packa
 
 ```diff
 import { TechDocsIndexPage, TechDocsReaderPage } from '@backstage/plugin-techdocs';
-+ import { TechDocsAddons } from '@backstage/techdocs-addons';
++ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
 + import { SomeAddon } from '@backstage/plugin-some-plugin';
 
 // ...
@@ -30,7 +30,7 @@ To customize the TechDocs reader experience on the Catalog entity page, update y
 
 ```diff
 import { EntityTechdocsContent } from '@backstage/plugin-techdocs';
-+ import { TechDocsAddons } from '@backstage/techdocs-addons';
++ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
 + import { SomeAddon } from '@backstage/plugin-some-plugin';
 
 // ...

packages/techdocs-addons/README.md

@@ -1,11 +0,0 @@
-# @backstage/techdocs-addons
-
-This package provides a TechDocs Addons framework used to create and consume TechDocs Addons.
-
-## Installation
-
-Install the package:
-
-```sh
-yarn add @backstage/techdocs-addons
-```

packages/techdocs-cli-embedded-app/package.json

@@ -17,7 +17,7 @@
     "@backstage/integration-react": "^1.0.1-next.1",
     "@backstage/plugin-catalog": "^1.1.0-next.1",
     "@backstage/plugin-techdocs": "^1.0.1-next.1",
-    "@backstage/techdocs-addons": "^0.0.0",
+    "@backstage/plugin-techdocs-react": "^0.0.0",
     "@backstage/test-utils": "^1.0.1-next.1",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.11.0",

packages/techdocs-cli-embedded-app/src/App.tsx

@@ -27,7 +27,7 @@ import {
   createTechDocsAddon,
   TechDocsAddons,
   TechDocsAddonLocations,
-} from '@backstage/techdocs-addons';
+} from '@backstage/plugin-techdocs-react';
 import { createApp } from '@backstage/app-defaults';
 import { FlatRoutes } from '@backstage/core-app-api';
 import { CatalogEntityPage } from '@backstage/plugin-catalog';

plugins/techdocs-react/README.md

@@ -0,0 +1,9 @@
+# @backstage/plugin-techdocs-react
+
+This package provides frontend utilities for TechDocs and Addons.
+
+## Installation
+
+```sh
+yarn add @backstage/plugin-techdocs-react
+```

plugins/techdocs-react/api-report.md

@@ -1,4 +1,4 @@
-## API Report File for "@backstage/techdocs-addons"
+## API Report File for "@backstage/plugin-techdocs-react"
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 

plugins/techdocs-react/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@backstage/techdocs-addons",
-  "description": "TechDocs Addons Framework",
+  "name": "@backstage/plugin-techdocs-react",
+  "description": "Shared frontend utilities for TechDocs and Addons",
   "version": "0.0.0",
   "private": false,
   "publishConfig": {
@@ -15,7 +15,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
-    "directory": "packages/techdocs-addons"
+    "directory": "plugins/techdocs-react"
   },
   "keywords": [
     "backstage",

plugins/techdocs-react/src/types.ts

@@ -68,7 +68,7 @@ export enum TechDocsAddonLocations {
    * the react component that would be rendered in place of all instances of
    * the markdown illustrated above.
    *
-   * The `@backstage/techdocs-addons` plugin would need to be updated to, in
+   * The `@backstage/plugin-techdocs-react` package would need to be updated to, in
    * cases where such addons had been registered, find all instances of the
    * rendered markdown (e.g. `<a href="{entityRef}">CatalogEntityCard</a>`) and
    * replace them with react portals to the addon component.

plugins/techdocs/package.json

@@ -46,7 +46,7 @@
     "@backstage/plugin-catalog-react": "^1.0.1-next.2",
     "@backstage/plugin-catalog": "^1.1.0-next.2",
     "@backstage/plugin-search": "^0.7.5-next.0",
-    "@backstage/techdocs-addons": "^0.0.0",
+    "@backstage/plugin-techdocs-react": "^0.0.0",
     "@backstage/version-bridge": "^1.0.0",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.12.2",

plugins/techdocs/src/reader/components/TechDocsReaderPage/TechDocsReaderPage.tsx

@@ -19,7 +19,7 @@ import { useOutlet, useParams } from 'react-router-dom';
 
 import { Page } from '@backstage/core-components';
 import { CompoundEntityRef } from '@backstage/catalog-model';
-import { TECHDOCS_ADDONS_WRAPPER_KEY } from '@backstage/techdocs-addons';
+import { TECHDOCS_ADDONS_WRAPPER_KEY } from '@backstage/plugin-techdocs-react';
 
 import { TechDocsReaderPageRenderFunction } from '../../../types';
 

plugins/techdocs/src/reader/components/TechDocsReaderPageContent/TechDocsReaderPageContent.tsx

@@ -23,7 +23,7 @@ import { StylesProvider, jssPreset } from '@material-ui/styles';
 import {
   useTechDocsAddons,
   TechDocsAddonLocations as locations,
-} from '@backstage/techdocs-addons';
+} from '@backstage/plugin-techdocs-react';
 import { CompoundEntityRef } from '@backstage/catalog-model';
 import { Content, Progress } from '@backstage/core-components';
 

plugins/techdocs/src/reader/components/TechDocsReaderPageHeader/TechDocsReaderPageHeader.tsx

@@ -23,7 +23,7 @@ import CodeIcon from '@material-ui/icons/Code';
 import {
   TechDocsAddonLocations as locations,
   useTechDocsAddons,
-} from '@backstage/techdocs-addons';
+} from '@backstage/plugin-techdocs-react';
 import {
   EntityRefLink,
   EntityRefLinks,

plugins/techdocs/src/reader/components/TechDocsReaderPageSubheader/TechDocsReaderPageSubheader.tsx

@@ -21,7 +21,7 @@ import { Box, Toolbar, ToolbarProps, withStyles } from '@material-ui/core';
 import {
   TechDocsAddonLocations as locations,
   useTechDocsAddons,
-} from '@backstage/techdocs-addons';
+} from '@backstage/plugin-techdocs-react';
 
 /**
  * Renders the reader page subheader.

scripts/api-extractor.ts

@@ -225,7 +225,6 @@ const NO_WARNING_PACKAGES = [
   'packages/integration',
   'packages/integration-react',
   'packages/search-common',
-  'packages/techdocs-addons',
   'packages/techdocs-common',
   'packages/test-utils',
   'packages/theme',
@@ -261,6 +260,7 @@ const NO_WARNING_PACKAGES = [
   'plugins/techdocs',
   'plugins/techdocs-backend',
   'plugins/techdocs-node',
+  'plugins/techdocs-react',
   'plugins/tech-insights',
   'plugins/tech-insights-backend',
   'plugins/tech-insights-backend-module-jsonfc',