Merge pull request #3807 from adamdmharvey/deprecate-register-componnet

api-docs: Update register API link, deprecate register-component

.changeset/famous-eagles-swim.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-register-component': patch
+---
+
+Register component plugin is deprecated in favor of @backstage/plugin-catalog-import

.changeset/gentle-dragons-marry.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-api-docs': patch
+---
+
+Link register API to catalog-import plugin

plugins/api-docs/src/components/ApiExplorerPage/ApiExplorerPage.tsx

@@ -37,7 +37,7 @@ export const ApiExplorerPage = () => {
             variant="contained"
             color="primary"
             component={RouterLink}
-            to="/register-component"
+            to="/catalog-import"
           >
             Register Existing API
           </Button>

plugins/register-component/README.md

@@ -1,5 +1,7 @@
 # Register component plugin
 
+> This plugin is deprecated in favor of [`@backstage/catalog-import`](https://github.com/backstage/backstage/tree/master/plugins/catalog-import), and will be soon removed from the project.
+
 Welcome to the register-component plugin!
 
 This plugin allows you to submit your Backstage component using your software's YAML config.

plugins/register-component/src/components/Router.tsx

@@ -20,6 +20,13 @@ import { RouteRef } from '@backstage/core';
 
 // As we don't know which path the catalog's router mounted on
 // We need to inject this from the app
+
+/**
+ * Provides a router for registering a component.
+ *
+ * @deprecated The router for this component is deprecated and replaced with the `catalog-import` plugin.
+ * @see https://github.com/backstage/backstage/tree/master/plugins/catalog-import
+ */
 export const Router = ({ catalogRouteRef }: { catalogRouteRef: RouteRef }) => (
   <Routes>
     <Route