@backstage/plugin-techdocs 0.13.3-next.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,77 @@
 # @backstage/plugin-techdocs
 
+## 0.14.0
+
+### Minor Changes
+
+- 2262fe19c9: **BREAKING**: Removed support for passing in an explicit `entity` prop to entity page extensions, which has been deprecated for a long time. This is only a breaking change at the TypeScript level, as this property was already ignored.
+- 4faae902eb: Adjust the Tech Docs page theme as a side effect of the `mkdocs-material` theme update.
+
+  If you use the `spofify/techdocs` image to build your documentation, make sure you use version `spotify/techdocs:v0.3.7`.
+
+  **Breaking**: The `PyMdown` extensions have also been updated and some syntax may have changed, so it is recommended that you check the extension's documentation if something stops working.
+  For example, the syntax of tags below was deprecated in `PyMdown` extensions `v.7.0` and in `v.8.0.0` it has been removed. This means that the old syntax specified below no longer works.
+
+  ````markdown
+  ```markdown tab="tab"
+  This is some markdown
+  ```
+
+  ```markdown tab="tab 2"
+  This is some markdown in tab 2
+  ```
+  ````
+
+### Patch Changes
+
+- 3bbb4d98c6: Changed <TechdocsPage /> to use <NotFoundErrorPage /> from createApp
+- ed09ad8093: Updated usage of the `LocationSpec` type from `@backstage/catalog-model`, which is deprecated.
+- b776ce5aab: Replaced use of deprecated `useEntityListProvider` hook with `useEntityList`.
+- d4f67fa728: Removed import of deprecated hook.
+- 45e1706328: Continuation of [#9569](https://github.com/backstage/backstage/pull/9569), fix Tech Docs Reader search position to be the same width as content.
+- 919cf2f836: Minor updates to match the new `targetRef` field of relations, and to stop consuming the `target` field
+- Updated dependencies
+  - @backstage/plugin-catalog@0.9.0
+  - @backstage/core-components@0.8.10
+  - @backstage/plugin-catalog-react@0.7.0
+  - @backstage/catalog-model@0.11.0
+  - @backstage/core-plugin-api@0.7.0
+  - @backstage/integration@0.7.5
+  - @backstage/plugin-search@0.7.1
+  - @backstage/integration-react@0.1.23
+
+## 0.13.4
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 6553985cd4: Match text size of admonitions to main content text size.
+- 9df7b43e1a: Improve overall appearance of highlighted code in docs.
+- Updated dependencies
+  - @backstage/core-components@0.8.9
+  - @backstage/core-plugin-api@0.6.1
+  - @backstage/errors@0.2.1
+  - @backstage/integration@0.7.3
+  - @backstage/integration-react@0.1.22
+  - @backstage/plugin-catalog@0.8.0
+  - @backstage/plugin-catalog-react@0.6.15
+  - @backstage/plugin-search@0.7.0
+  - @backstage/catalog-model@0.10.0
+  - @backstage/config@0.1.14
+  - @backstage/theme@0.2.15
+
+## 0.13.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-components@0.8.8
+  - @backstage/plugin-search@0.6.2
+  - @backstage/plugin-catalog-react@0.6.14
+  - @backstage/plugin-catalog@0.7.12
+  - @backstage/integration-react@0.1.21
+
 ## 0.13.3-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -2,13 +2,13 @@
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { DiscoveryApi, FetchApi, IdentityApi } from '@backstage/core-plugin-api';
 import * as _backstage_catalog_model from '@backstage/catalog-model';
-import { Entity, LocationSpec, EntityName } from '@backstage/catalog-model';
+import { Entity, EntityName } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 import * as _backstage_core_components from '@backstage/core-components';
 import { TableColumn, TableProps } from '@backstage/core-components';
 import { UserListFilterKind } from '@backstage/plugin-catalog-react';
 import { CSSProperties } from '@material-ui/styles';
-import React from 'react';
+import React, { PropsWithChildren } from 'react';
 import * as _material_table_core from '@material-table/core';
 
 declare type TechDocsMetadata = {
@@ -16,7 +16,10 @@ declare type TechDocsMetadata = {
     site_description: string;
 };
 declare type TechDocsEntityMetadata = Entity & {
-    locationMetadata?: LocationSpec;
+    locationMetadata?: {
+        type: string;
+        target: string;
+    };
 };
 
 /**
@@ -256,9 +259,7 @@ declare const techdocsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
     entityContent: _backstage_core_plugin_api.RouteRef<undefined>;
 }, {}>;
 declare const TechdocsPage: () => JSX.Element;
-declare const EntityTechdocsContent: (_props: {
-    entity?: _backstage_catalog_model.Entity | undefined;
-}) => JSX.Element;
+declare const EntityTechdocsContent: (_props: {}) => JSX.Element;
 declare const DocsCardGrid: ({ entities, }: {
     entities: _backstage_catalog_model.Entity[] | undefined;
 }) => JSX.Element | null;
@@ -285,19 +286,16 @@ declare type Props$1 = {
 };
 declare const Reader: ({ entityRef, onReady, withSearch, }: Props$1) => JSX.Element;
 
-declare type TechDocsPageHeaderProps = {
+declare type TechDocsPageHeaderProps = PropsWithChildren<{
     entityRef: EntityName;
     entityMetadata?: TechDocsEntityMetadata;
     techDocsMetadata?: TechDocsMetadata;
-};
-declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, }: TechDocsPageHeaderProps) => JSX.Element;
+}>;
+declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, children, }: TechDocsPageHeaderProps) => JSX.Element;
 
 declare const isTechDocsAvailable: (entity: Entity) => boolean;
 declare const Router: () => JSX.Element;
-declare type Props = {
-    /** @deprecated The entity is now grabbed from context instead */
-    entity?: Entity;
-};
+declare type Props = {};
 declare const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
 
 export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsGrid, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPage, TechDocsPageHeader, TechDocsPageHeaderProps, TechDocsPageProps, TechDocsPageRenderFunction, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };