paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/backstage/backstage into feat/reference-external-docs

Browse Source
This commit is contained in:
jrwpatterson
2023-08-23 08:33:33 +10:00
parent b516f70b83 aa66a0bde0
commit 56e5baf7f0
1241 changed files with 43195 additions and 8974 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs/CHANGELOG.md
+45
View File
@@ -1,5 +1,50 @@
# @backstage/plugin-techdocs
## 1.6.8-next.0
### Patch Changes
- 88c9525a36f3: Fixed bug in styles that caused next and previous links in footer to overlap page content.
- Updated dependencies
- @backstage/integration-react@1.1.18-next.0
- @backstage/integration@1.7.0-next.0
- @backstage/core-plugin-api@1.6.0-next.0
- @backstage/core-components@0.13.5-next.0
- @backstage/catalog-model@1.4.1
- @backstage/config@1.0.8
- @backstage/errors@1.2.1
- @backstage/theme@0.4.1
- @backstage/plugin-catalog-react@1.8.3-next.0
- @backstage/plugin-search-common@1.2.5
- @backstage/plugin-search-react@1.6.5-next.0
- @backstage/plugin-techdocs-react@1.1.10-next.0
## 1.6.6
### Patch Changes
- Updated dependencies
- @backstage/integration-react@1.1.16
- @backstage/integration@1.6.0
- @backstage/core-components@0.13.4
- @backstage/plugin-catalog-react@1.8.1
- @backstage/core-plugin-api@1.5.3
- @backstage/plugin-search-react@1.6.4
- @backstage/catalog-model@1.4.1
- @backstage/config@1.0.8
- @backstage/errors@1.2.1
- @backstage/theme@0.4.1
- @backstage/plugin-search-common@1.2.5
- @backstage/plugin-techdocs-react@1.1.9
## 1.6.6-next.2
### Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@1.8.1-next.1
- @backstage/integration-react@1.1.16-next.1
## 1.6.6-next.1
### Patch Changes
plugins/techdocs/api-report.md
+33 -24
View File
@@ -14,6 +14,7 @@ import { DiscoveryApi } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { FetchApi } from '@backstage/core-plugin-api';
import { IdentityApi } from '@backstage/core-plugin-api';
import { JSX as JSX_2 } from 'react';
import { PropsWithChildren } from 'react';
import { default as React_2 } from 'react';
import { ReactNode } from 'react';
@@ -51,13 +52,15 @@ export type ContentStateTypes =
// @public
export const DefaultTechDocsHome: (
props: TechDocsIndexPageProps,
) => JSX.Element;
) => React_2.JSX.Element;
// @public @deprecated
export type DefaultTechDocsHomeProps = TechDocsIndexPageProps;
// @public
export const DocsCardGrid: (props: DocsCardGridProps) => JSX.Element | null;
export const DocsCardGrid: (
props: DocsCardGridProps,
) => React_2.JSX.Element | null;
// @public
export type DocsCardGridProps = {
@@ -72,7 +75,7 @@ export type DocsGroupConfig = {
// @public
export const DocsTable: {
(props: DocsTableProps): JSX.Element | null;
(props: DocsTableProps): React_2.JSX.Element | null;
columns: {
createNameColumn(): TableColumn<DocsTableRow>;
createOwnerColumn(): TableColumn<DocsTableRow>;
@@ -80,7 +83,7 @@ export const DocsTable: {
};
actions: {
createCopyDocsUrlAction(copyToClipboard: Function): (row: DocsTableRow) => {
icon: () => JSX.Element;
icon: () => React_2.JSX.Element;
tooltip: string;
onClick: () => any;
};
@@ -91,7 +94,7 @@ export const DocsTable: {
cellStyle: {
paddingLeft: string;
};
icon: () => JSX.Element;
icon: () => React_2.JSX.Element;
tooltip: string;
onClick: () => any;
};
@@ -121,12 +124,12 @@ export type DocsTableRow = {
// @public
export const EmbeddedDocsRouter: (
props: PropsWithChildren<{}>,
) => JSX.Element | null;
) => React_2.JSX.Element | null;
// @public
export const EntityListDocsGrid: (
props: EntityListDocsGridPageProps,
) => JSX.Element;
) => React_2.JSX.Element;
// @public
export type EntityListDocsGridPageProps = {
@@ -135,7 +138,7 @@ export type EntityListDocsGridPageProps = {
// @public
export const EntityListDocsTable: {
(props: EntityListDocsTableProps): JSX.Element;
(props: EntityListDocsTableProps): React_2.JSX.Element;
columns: {
createNameColumn(): TableColumn<DocsTableRow>;
createOwnerColumn(): TableColumn<DocsTableRow>;
@@ -143,7 +146,7 @@ export const EntityListDocsTable: {
};
actions: {
createCopyDocsUrlAction(copyToClipboard: Function): (row: DocsTableRow) => {
icon: () => JSX.Element;
icon: () => React_2.JSX.Element;
tooltip: string;
onClick: () => any;
};
@@ -154,7 +157,7 @@ export const EntityListDocsTable: {
cellStyle: {
paddingLeft: string;
};
icon: () => JSX.Element;
icon: () => React_2.JSX.Element;
tooltip: string;
onClick: () => any;
};
@@ -171,7 +174,7 @@ export type EntityListDocsTableProps = {
// @public
export const EntityTechdocsContent: (props: {
children?: ReactNode;
}) => JSX.Element | null;
}) => JSX_2.Element | null;
// @public
export const isTechDocsAvailable: (entity: Entity) => boolean;
@@ -194,7 +197,9 @@ export interface PanelConfig {
export type PanelType = 'DocsCardGrid' | 'DocsTable';
// @public @deprecated
export const Reader: (props: TechDocsReaderPageContentProps) => JSX.Element;
export const Reader: (
props: TechDocsReaderPageContentProps,
) => React_2.JSX.Element;
// @public
export type ReaderState = {
@@ -208,7 +213,7 @@ export type ReaderState = {
};
// @public
export const Router: () => JSX.Element;
export const Router: () => React_2.JSX.Element;
// @public @deprecated
export type SyncResult = 'cached' | 'updated';
@@ -261,7 +266,7 @@ export class TechDocsClient implements TechDocsApi_2 {
// @public
export const TechDocsCustomHome: (
props: TechDocsCustomHomeProps,
) => JSX.Element;
) => JSX_2.Element;
// @public
export type TechDocsCustomHomeProps = {
@@ -272,7 +277,9 @@ export type TechDocsCustomHomeProps = {
export type TechDocsEntityMetadata = TechDocsEntityMetadata_2;
// @public
export const TechDocsIndexPage: (props: TechDocsIndexPageProps) => JSX.Element;
export const TechDocsIndexPage: (
props: TechDocsIndexPageProps,
) => JSX_2.Element;
// @public
export type TechDocsIndexPageProps = {
@@ -285,12 +292,12 @@ export type TechDocsIndexPageProps = {
export type TechDocsMetadata = TechDocsMetadata_2;
// @public
export const TechdocsPage: () => JSX.Element;
export const TechdocsPage: () => JSX_2.Element;
// @public
export const TechDocsPageWrapper: (
props: TechDocsPageWrapperProps,
) => JSX.Element;
) => React_2.JSX.Element;
// @public
export type TechDocsPageWrapperProps = {
@@ -320,7 +327,7 @@ export { techdocsPlugin };
// @public
export const TechDocsReaderLayout: (
props: TechDocsReaderLayoutProps,
) => JSX.Element;
) => React_2.JSX.Element;
// @public
export type TechDocsReaderLayoutProps = {
@@ -331,12 +338,12 @@ export type TechDocsReaderLayoutProps = {
// @public
export const TechDocsReaderPage: (
props: TechDocsReaderPageProps,
) => JSX.Element;
) => JSX_2.Element;
// @public
export const TechDocsReaderPageContent: (
props: TechDocsReaderPageContentProps,
) => JSX.Element;
) => React_2.JSX.Element;
// @public
export type TechDocsReaderPageContentProps = {
@@ -348,7 +355,7 @@ export type TechDocsReaderPageContentProps = {
// @public
export const TechDocsReaderPageHeader: (
props: TechDocsReaderPageHeaderProps,
) => JSX.Element | null;
) => React_2.JSX.Element | null;
// @public @deprecated
export type TechDocsReaderPageHeaderProps = PropsWithChildren<{
@@ -374,12 +381,12 @@ export type TechDocsReaderPageRenderFunction = (options: {
// @public
export const TechDocsReaderPageSubheader: (props: {
toolbarProps?: ToolbarProps;
}) => JSX.Element | null;
}) => React_2.JSX.Element | null;
// @public
export const TechDocsReaderProvider: (
props: TechDocsReaderProviderProps,
) => JSX.Element;
) => React_2.JSX.Element;
// @public
export type TechDocsReaderProviderProps = {
@@ -392,7 +399,9 @@ export type TechDocsReaderProviderRenderFunction = (
) => JSX.Element;
// @public
export const TechDocsSearch: (props: TechDocsSearchProps) => JSX.Element;
export const TechDocsSearch: (
props: TechDocsSearchProps,
) => React_2.JSX.Element;
// @public
export type TechDocsSearchProps = {
plugins/techdocs/catalog-info.yaml
+12
View File
@@ -0,0 +1,12 @@
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: backstage-plugin-techdocs
title: '@backstage/plugin-techdocs'
description: >-
The Backstage plugin that renders technical documentation for your
components
spec:
lifecycle: production
type: backstage-frontend-plugin
owner: techdocs-maintainers
plugins/techdocs/package.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-techdocs",
"description": "The Backstage plugin that renders technical documentation for your components",
"version": "1.6.6-next.1",
"version": "1.6.8-next.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
plugins/techdocs/src/reader/transformers/styles/rules/layout.ts
+1 -1
View File
@@ -120,7 +120,7 @@ export default ({ theme, sidebar }: RuleOptions) => `
.md-footer__title {
background-color: unset;
}
.md-footer-nav__link {
.md-footer-nav__link, .md-footer__link {
width: 16rem;
}