diff --git a/plugins/techdocs/src/reader/components/TechDocsPageHeader.test.tsx b/plugins/techdocs/src/reader/components/TechDocsReaderPageHeader.test.tsx
similarity index 93%
rename from plugins/techdocs/src/reader/components/TechDocsPageHeader.test.tsx
rename to plugins/techdocs/src/reader/components/TechDocsReaderPageHeader.test.tsx
index 4fa43bfed5..9245bb66c5 100644
--- a/plugins/techdocs/src/reader/components/TechDocsPageHeader.test.tsx
+++ b/plugins/techdocs/src/reader/components/TechDocsReaderPageHeader.test.tsx
@@ -14,17 +14,17 @@
* limitations under the License.
*/
import React from 'react';
-import { TechDocsPageHeader } from './TechDocsPageHeader';
+import { TechDocsReaderPageHeader } from './TechDocsReaderPageHeader';
import { act } from '@testing-library/react';
import { renderInTestApp } from '@backstage/test-utils';
import { entityRouteRef } from '@backstage/plugin-catalog-react';
import { rootRouteRef } from '../../routes';
-describe('', () => {
+describe('', () => {
it('should render a techdocs page header', async () => {
await act(async () => {
const rendered = await renderInTestApp(
- ', () => {
it('should render a techdocs page header even if metadata is missing', async () => {
await act(async () => {
const rendered = await renderInTestApp(
- ', () => {
it('should render a link back to the component page', async () => {
await act(async () => {
const rendered = await renderInTestApp(
- ;
-export const TechDocsPageHeader = ({
+/**
+ * Component responsible for rendering a Header with metadata on TechDocs reader page.
+ *
+ * @public
+ */
+export const TechDocsReaderPageHeader = ({
entityRef,
entityMetadata,
techDocsMetadata,
children,
-}: TechDocsPageHeaderProps) => {
+}: TechDocsReaderPageHeaderProps) => {
const { name } = entityRef;
const { site_name: siteName, site_description: siteDescription } =
@@ -114,3 +124,16 @@ export const TechDocsPageHeader = ({
);
};
+
+/**
+ * @public
+ * @deprecated use {@link TechDocsReaderPageHeader} instead
+ */
+export const TechDocsPageHeader = TechDocsReaderPageHeader;
+
+/**
+ * @public
+ * @deprecated use {@link TechDocsReaderPageHeader} instead
+ */
+
+export type TechDocsPageHeaderProps = TechDocsReaderPageHeaderProps;