Merge branch 'master' into techdocs/remove-warnings
Signed-off-by: Morgan Bentell <morgan.bentell@gmail.com>
This commit is contained in:
@@ -1,5 +1,74 @@
|
||||
# @backstage/plugin-techdocs
|
||||
|
||||
## 1.6.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 3f75b7607ca: Add ability to pass icon as function to have ability to customize it by search item
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 65454876fb2: Minor API report tweaks
|
||||
- 54a1e133b56: Fix bug that caused next and previous links not to work with certain versions of mkdocs-material
|
||||
- f320c299c67: The HTML tag attributes in the documentation content inserted to shadow DOM is preserved to improve accessibility
|
||||
- cb8ec97cdeb: Change black & white colors to be theme aware
|
||||
- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
|
||||
- 8adfda60ae1: Updated dependency `jss` to `~10.10.0`.
|
||||
- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
|
||||
- 238cf657c09: Copy to clipboard now works in a not secure context.
|
||||
- Updated dependencies
|
||||
- @backstage/core-components@0.12.5
|
||||
- @backstage/plugin-techdocs-react@1.1.4
|
||||
- @backstage/plugin-catalog-react@1.4.0
|
||||
- @backstage/plugin-search-react@1.5.1
|
||||
- @backstage/errors@1.1.5
|
||||
- @backstage/core-plugin-api@1.5.0
|
||||
- @backstage/catalog-model@1.2.1
|
||||
- @backstage/integration-react@1.1.11
|
||||
- @backstage/integration@1.4.3
|
||||
- @backstage/config@1.0.7
|
||||
- @backstage/theme@0.2.18
|
||||
- @backstage/plugin-search-common@1.2.2
|
||||
|
||||
## 1.6.0-next.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 65454876fb2: Minor API report tweaks
|
||||
- Updated dependencies
|
||||
- @backstage/core-components@0.12.5-next.2
|
||||
- @backstage/plugin-techdocs-react@1.1.4-next.2
|
||||
- @backstage/plugin-catalog-react@1.4.0-next.2
|
||||
- @backstage/plugin-search-react@1.5.1-next.2
|
||||
- @backstage/core-plugin-api@1.5.0-next.2
|
||||
- @backstage/integration-react@1.1.11-next.2
|
||||
- @backstage/config@1.0.7-next.0
|
||||
- @backstage/integration@1.4.3-next.0
|
||||
|
||||
## 1.6.0-next.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 54a1e133b56: Fix bug that caused next and previous links not to work with certain versions of mkdocs-material
|
||||
- cb8ec97cdeb: Change black & white colors to be theme aware
|
||||
- c10384a9235: Switch to using `LinkButton` instead of the deprecated `Button`
|
||||
- 8adfda60ae1: Updated dependency `jss` to `~10.10.0`.
|
||||
- 52b0022dab7: Updated dependency `msw` to `^1.0.0`.
|
||||
- 238cf657c09: Copy to clipboard now works in a not secure context.
|
||||
- Updated dependencies
|
||||
- @backstage/core-components@0.12.5-next.1
|
||||
- @backstage/errors@1.1.5-next.0
|
||||
- @backstage/plugin-techdocs-react@1.1.4-next.1
|
||||
- @backstage/core-plugin-api@1.4.1-next.1
|
||||
- @backstage/integration-react@1.1.11-next.1
|
||||
- @backstage/integration@1.4.3-next.0
|
||||
- @backstage/config@1.0.7-next.0
|
||||
- @backstage/theme@0.2.18-next.0
|
||||
- @backstage/plugin-catalog-react@1.4.0-next.1
|
||||
- @backstage/catalog-model@1.2.1-next.1
|
||||
- @backstage/plugin-search-common@1.2.2-next.0
|
||||
- @backstage/plugin-search-react@1.5.1-next.1
|
||||
|
||||
## 1.6.0-next.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -84,7 +84,7 @@ export const DocsTable: {
|
||||
createStarEntityAction(
|
||||
isStarredEntity: Function,
|
||||
toggleStarredEntity: Function,
|
||||
): ({ entity }: DocsTableRow) => {
|
||||
): (row: DocsTableRow) => {
|
||||
cellStyle: {
|
||||
paddingLeft: string;
|
||||
};
|
||||
@@ -121,9 +121,9 @@ export const EmbeddedDocsRouter: (
|
||||
) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export const EntityListDocsGrid: ({
|
||||
groups,
|
||||
}: EntityListDocsGridPageProps) => JSX.Element;
|
||||
export const EntityListDocsGrid: (
|
||||
props: EntityListDocsGridPageProps,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export type EntityListDocsGridPageProps = {
|
||||
@@ -147,7 +147,7 @@ export const EntityListDocsTable: {
|
||||
createStarEntityAction(
|
||||
isStarredEntity: Function,
|
||||
toggleStarredEntity: Function,
|
||||
): ({ entity }: DocsTableRow) => {
|
||||
): (row: DocsTableRow) => {
|
||||
cellStyle: {
|
||||
paddingLeft: string;
|
||||
};
|
||||
@@ -315,10 +315,9 @@ export { techdocsPlugin as plugin };
|
||||
export { techdocsPlugin };
|
||||
|
||||
// @public
|
||||
export const TechDocsReaderLayout: ({
|
||||
withSearch,
|
||||
withHeader,
|
||||
}: TechDocsReaderLayoutProps) => JSX.Element;
|
||||
export const TechDocsReaderLayout: (
|
||||
props: TechDocsReaderLayoutProps,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export type TechDocsReaderLayoutProps = {
|
||||
@@ -375,9 +374,9 @@ export const TechDocsReaderPageSubheader: (props: {
|
||||
}) => JSX.Element | null;
|
||||
|
||||
// @public
|
||||
export const TechDocsReaderProvider: ({
|
||||
children,
|
||||
}: TechDocsReaderProviderProps) => JSX.Element;
|
||||
export const TechDocsReaderProvider: (
|
||||
props: TechDocsReaderProviderProps,
|
||||
) => JSX.Element;
|
||||
|
||||
// @public
|
||||
export type TechDocsReaderProviderProps = {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@backstage/plugin-techdocs",
|
||||
"description": "The Backstage plugin that renders technical documentation for your components",
|
||||
"version": "1.6.0-next.0",
|
||||
"version": "1.6.0",
|
||||
"main": "src/index.ts",
|
||||
"types": "src/index.ts",
|
||||
"license": "Apache-2.0",
|
||||
|
||||
@@ -55,13 +55,11 @@ const allEntitiesGroup: DocsGroupConfig = {
|
||||
filterPredicate: () => true,
|
||||
};
|
||||
|
||||
const EntityListDocsGridGroup = ({
|
||||
entities,
|
||||
group,
|
||||
}: {
|
||||
const EntityListDocsGridGroup = (props: {
|
||||
group: DocsGroupConfig;
|
||||
entities: Entity[];
|
||||
}) => {
|
||||
const { entities, group } = props;
|
||||
const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();
|
||||
|
||||
const shownEntities = entities.filter(entity => {
|
||||
@@ -103,7 +101,7 @@ const EntityListDocsGridGroup = ({
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export const EntityListDocsGrid = ({ groups }: EntityListDocsGridPageProps) => {
|
||||
export const EntityListDocsGrid = (props: EntityListDocsGridPageProps) => {
|
||||
const { loading, error, entities } = useEntityList();
|
||||
|
||||
if (error) {
|
||||
@@ -143,7 +141,7 @@ export const EntityListDocsGrid = ({ groups }: EntityListDocsGridPageProps) => {
|
||||
|
||||
return (
|
||||
<Content>
|
||||
{(groups || [allEntitiesGroup]).map((group, index: number) => (
|
||||
{(props.groups || [allEntitiesGroup]).map((group, index: number) => (
|
||||
<EntityListDocsGridGroup
|
||||
entities={entities}
|
||||
group={group}
|
||||
|
||||
@@ -47,7 +47,8 @@ export const actionFactories = {
|
||||
isStarredEntity: Function,
|
||||
toggleStarredEntity: Function,
|
||||
) {
|
||||
return ({ entity }: DocsTableRow) => {
|
||||
return (row: DocsTableRow) => {
|
||||
const entity = row.entity;
|
||||
const isStarred = isStarredEntity(entity);
|
||||
return {
|
||||
cellStyle: { paddingLeft: '1em' },
|
||||
|
||||
@@ -132,10 +132,8 @@ export type TechDocsReaderLayoutProps = {
|
||||
* Default TechDocs reader page structure composed with a header and content
|
||||
* @public
|
||||
*/
|
||||
export const TechDocsReaderLayout = ({
|
||||
withSearch,
|
||||
withHeader = true,
|
||||
}: TechDocsReaderLayoutProps) => {
|
||||
export const TechDocsReaderLayout = (props: TechDocsReaderLayoutProps) => {
|
||||
const { withSearch, withHeader = true } = props;
|
||||
return (
|
||||
<Page themeId="documentation">
|
||||
{withHeader && <TechDocsReaderPageHeader />}
|
||||
|
||||
@@ -48,9 +48,9 @@ export type TechDocsReaderProviderProps = {
|
||||
*
|
||||
* @public
|
||||
*/
|
||||
export const TechDocsReaderProvider = ({
|
||||
children,
|
||||
}: TechDocsReaderProviderProps) => {
|
||||
export const TechDocsReaderProvider = (props: TechDocsReaderProviderProps) => {
|
||||
const { children } = props;
|
||||
|
||||
const { '*': path = '' } = useParams();
|
||||
const { entityRef } = useTechDocsReaderPage();
|
||||
const { kind, namespace, name } = entityRef;
|
||||
|
||||
Reference in New Issue
Block a user