From f78cf32e6782842f3fdaa8d219ca22b8939529c8 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 21 Dec 2020 14:00:39 -0500 Subject: [PATCH] Add deprecated TSDOC --- plugins/register-component/src/components/Router.tsx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/plugins/register-component/src/components/Router.tsx b/plugins/register-component/src/components/Router.tsx index eee7fd3806..16aa1fa695 100644 --- a/plugins/register-component/src/components/Router.tsx +++ b/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 }) => (