From 2fb1d5e622c7632e82a2d07701d2b681dbce52ce Mon Sep 17 00:00:00 2001
From: Emma Indal <emma.indahl@gmail.com>
Date: Tue, 22 Feb 2022 15:36:09 +0100
Subject: [PATCH] TechDocs reader page header to follow new naming pattern

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
---
 ....tsx => TechDocsReaderPageHeader.test.tsx} | 10 +++----
 ...eader.tsx => TechDocsReaderPageHeader.tsx} | 29 +++++++++++++++++--
 2 files changed, 31 insertions(+), 8 deletions(-)
 rename plugins/techdocs/src/reader/components/{TechDocsPageHeader.test.tsx => TechDocsReaderPageHeader.test.tsx} (93%)
 rename plugins/techdocs/src/reader/components/{TechDocsPageHeader.tsx => TechDocsReaderPageHeader.tsx} (83%)

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('<TechDocsPageHeader />', () => {
+describe('<TechDocsReaderPageHeader />', () => {
   it('should render a techdocs page header', async () => {
     await act(async () => {
       const rendered = await renderInTestApp(
-        <TechDocsPageHeader
+        <TechDocsReaderPageHeader
           entityRef={{
             kind: 'test',
             name: 'test-name',
@@ -66,7 +66,7 @@ describe('<TechDocsPageHeader />', () => {
   it('should render a techdocs page header even if metadata is missing', async () => {
     await act(async () => {
       const rendered = await renderInTestApp(
-        <TechDocsPageHeader
+        <TechDocsReaderPageHeader
           entityRef={{
             kind: 'test',
             name: 'test-name',
@@ -88,7 +88,7 @@ describe('<TechDocsPageHeader />', () => {
   it('should render a link back to the component page', async () => {
     await act(async () => {
       const rendered = await renderInTestApp(
-        <TechDocsPageHeader
+        <TechDocsReaderPageHeader
           entityRef={{
             kind: 'test',
             name: 'test-name',
diff --git a/plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx b/plugins/techdocs/src/reader/components/TechDocsReaderPageHeader.tsx
similarity index 83%
rename from plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx
rename to plugins/techdocs/src/reader/components/TechDocsReaderPageHeader.tsx
index f56542773f..b260205156 100644
--- a/plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx
+++ b/plugins/techdocs/src/reader/components/TechDocsReaderPageHeader.tsx
@@ -29,18 +29,28 @@ import {
 import { rootRouteRef } from '../../routes';
 import { TechDocsEntityMetadata, TechDocsMetadata } from '../../types';
 
-export type TechDocsPageHeaderProps = PropsWithChildren<{
+/**
+ * Props for {@link TechDocsReaderPageHeader}
+ *
+ * @public
+ */
+export type TechDocsReaderPageHeaderProps = PropsWithChildren<{
   entityRef: EntityName;
   entityMetadata?: TechDocsEntityMetadata;
   techDocsMetadata?: TechDocsMetadata;
 }>;
 
-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 = ({
     </Header>
   );
 };
+
+/**
+ * @public
+ * @deprecated use {@link TechDocsReaderPageHeader} instead
+ */
+export const TechDocsPageHeader = TechDocsReaderPageHeader;
+
+/**
+ * @public
+ * @deprecated use {@link TechDocsReaderPageHeader} instead
+ */
+
+export type TechDocsPageHeaderProps = TechDocsReaderPageHeaderProps;