TechDocs reader page header to follow new naming pattern

Signed-off-by: Emma Indal <emma.indahl@gmail.com>

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',

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;