@backstage/plugin-techdocs 0.11.2 → 0.12.2

package/CHANGELOG.md

@@ -1,5 +1,77 @@
 # @backstage/plugin-techdocs
 
+## 0.12.2
+
+### Patch Changes
+
+- 76fef740fe: Refactored `<Reader />` component internals to support future extensibility.
+- Updated dependencies
+  - @backstage/plugin-catalog-react@0.6.0
+  - @backstage/plugin-catalog@0.7.1
+  - @backstage/integration@0.6.8
+  - @backstage/core-components@0.7.0
+  - @backstage/theme@0.2.11
+  - @backstage/plugin-search@0.4.15
+  - @backstage/integration-react@0.1.12
+
+## 0.12.1
+
+### Patch Changes
+
+- 81a41ec249: Added a `name` key to all extensions in order to improve Analytics API metadata.
+- Updated dependencies
+  - @backstage/core-components@0.6.1
+  - @backstage/core-plugin-api@0.1.10
+  - @backstage/plugin-catalog@0.7.0
+  - @backstage/plugin-catalog-react@0.5.2
+  - @backstage/catalog-model@0.9.4
+  - @backstage/integration@0.6.7
+  - @backstage/plugin-search@0.4.14
+
+## 0.12.0
+
+### Minor Changes
+
+- 82bb0842a3: Adds support for being able to customize and compose your TechDocs reader page in the App.
+
+  You can likely upgrade to this version without issue. If, however, you have
+  imported the `<Reader />` component in your custom code, the name of a property
+  has changed. You will need to make the following change anywhere you use it:
+
+  ```diff
+  -<Reader entityId={value} />
+  +<Reader entityRef={value} />
+  ```
+
+### Patch Changes
+
+- 79ebee7a6b: Add "data-testid" for e2e tests and fix techdocs entity not found error.
+- 3df2e8532b: Fixed the URL for the "Click to copy documentation link to clipboard" action
+- 0a8bec0877: Added a check for the TechDocs annotation on the entity
+- Updated dependencies
+  - @backstage/integration@0.6.6
+  - @backstage/core-plugin-api@0.1.9
+  - @backstage/core-components@0.6.0
+  - @backstage/integration-react@0.1.11
+  - @backstage/plugin-catalog@0.6.17
+  - @backstage/plugin-catalog-react@0.5.1
+  - @backstage/plugin-search@0.4.13
+
+## 0.11.3
+
+### Patch Changes
+
+- be13dfe61a: Make techdocs context search bar width adjust on smaller screens.
+- Updated dependencies
+  - @backstage/core-components@0.5.0
+  - @backstage/integration@0.6.5
+  - @backstage/plugin-catalog@0.6.16
+  - @backstage/plugin-catalog-react@0.5.0
+  - @backstage/catalog-model@0.9.3
+  - @backstage/config@0.1.10
+  - @backstage/integration-react@0.1.10
+  - @backstage/plugin-search@0.4.12
+
 ## 0.11.2
 
 ### Patch Changes

package/README.md

@@ -2,12 +2,12 @@
 
 ## Getting started
 
-Set up Backstage and TechDocs by follow our guide on [Getting Started](../../docs/features/techdocs/getting-started.md).
+Set up Backstage and TechDocs by following our guide on [Getting Started](../../docs/features/techdocs/getting-started.md).
 
 ## Configuration
 
-http://backstage.io/docs/features/techdocs/configuration
+Refer to our [configuration reference](../../docs/features/techdocs/configuration.md) for a complete listing of configuration options.
 
-### TechDocs Storage Api
+### TechDocs Storage API
 
-The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of `<storageUrl>/<entity kind>/<entity namespace>/<entity name>`. If for some reason you want to change this it can be configured by implementing a new techdocs storage API. Do this by implementing TechDocsStorage found in `plugins/techdocs/src/api`. Add your new API to the application in `app/src/apis.ts` (or replace if it's already registered as an API).
+The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of `<storageUrl>/<entity kind>/<entity namespace>/<entity name>`. This can be configured by [implementing a new techdocs storage API](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-implement-your-own-techdocs-apis).

package/dist/index.d.ts

@@ -200,6 +200,17 @@ declare const DocsResultListItem: ({ result, lineClamp, asListItem, asLink, titl
     title?: string | undefined;
 }) => JSX.Element;
 
+declare type TechDocsPageRenderFunction = ({ techdocsMetadataValue, entityMetadataValue, entityRef, }: {
+    techdocsMetadataValue?: TechDocsMetadata | undefined;
+    entityMetadataValue?: TechDocsEntityMetadata | undefined;
+    entityRef: EntityName;
+    onReady: () => void;
+}) => JSX.Element;
+declare type TechDocsPageProps = {
+    children?: TechDocsPageRenderFunction | React.ReactNode;
+};
+declare const TechDocsPage: ({ children }: TechDocsPageProps) => JSX.Element;
+
 declare const techdocsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
     root: _backstage_core_plugin_api.RouteRef<undefined>;
     docRoot: _backstage_core_plugin_api.RouteRef<{
@@ -230,15 +241,23 @@ declare const TechDocsCustomHome: ({ tabsConfig, }: {
     tabsConfig: TabsConfig;
 }) => JSX.Element;
 declare const TechDocsIndexPage: () => JSX.Element;
-declare const TechDocsReaderPage: () => JSX.Element;
+declare const TechDocsReaderPage: ({ children }: TechDocsPageProps) => JSX.Element;
 
 declare type Props$1 = {
-    entityId: EntityName;
-    onReady?: () => void;
+    entityRef: EntityName;
     withSearch?: boolean;
+    onReady?: () => void;
+};
+declare const Reader: ({ entityRef, onReady, withSearch, }: Props$1) => JSX.Element;
+
+declare type TechDocsPageHeaderProps = {
+    entityRef: EntityName;
+    entityMetadata?: TechDocsEntityMetadata;
+    techDocsMetadata?: TechDocsMetadata;
 };
-declare const Reader: ({ entityId, onReady, withSearch }: Props$1) => JSX.Element;
+declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, }: 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 */
@@ -246,4 +265,4 @@ declare type Props = {
 };
 declare const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
 
-export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };
+export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, 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 };