@backstage/plugin-techdocs 1.19.0-next.0 → 1.19.0-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -0
- package/dist/alpha.d.ts +0 -2
- package/dist/home/components/TechDocsPicker.esm.js +3 -3
- package/dist/home/components/TechDocsPicker.esm.js.map +1 -1
- package/dist/plugins/techdocs/package.json.esm.js +2 -1
- package/dist/plugins/techdocs/package.json.esm.js.map +1 -1
- package/dist/reader/components/TechDocsNotFound.esm.js +5 -19
- package/dist/reader/components/TechDocsNotFound.esm.js.map +1 -1
- package/dist/reader/components/TechDocsStateIndicator.esm.js +2 -8
- package/dist/reader/components/TechDocsStateIndicator.esm.js.map +1 -1
- package/dist/translation.esm.js +0 -4
- package/dist/translation.esm.js.map +1 -1
- package/package.json +13 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
+
## 1.19.0-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 6c74f3f: Migrated the `TechDocsPicker` filter from the deprecated `getCatalogFilters` to `getCatalogQuery`.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/frontend-plugin-api@0.18.2-next.1
|
|
10
|
+
- @backstage/catalog-client@1.16.3-next.1
|
|
11
|
+
- @backstage/plugin-catalog-react@3.3.0-next.2
|
|
12
|
+
- @backstage/core-components@0.18.15-next.3
|
|
13
|
+
- @backstage/ui@0.19.0-next.0
|
|
14
|
+
|
|
15
|
+
## 1.19.0-next.1
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- 4a5b52d: TechDocs now uses the default `NotFoundErrorPage` when documentation is missing, instead of its own TechDocs-specific page.
|
|
20
|
+
|
|
21
|
+
This means if you have provided an override to the `NotFoundErrorPage` component it will now be used within TechDocs when documentation is missing as well.
|
|
22
|
+
|
|
23
|
+
One thing to note is that the default not found page shows "PAGE NOT FOUND" rather than "Documentation not found".
|
|
24
|
+
|
|
25
|
+
### Patch Changes
|
|
26
|
+
|
|
27
|
+
- Updated dependencies
|
|
28
|
+
- @backstage/plugin-catalog-react@3.2.4-next.1
|
|
29
|
+
- @backstage/plugin-techdocs-react@1.3.16-next.2
|
|
30
|
+
- @backstage/core-components@0.18.15-next.2
|
|
31
|
+
- @backstage/integration@2.1.3-next.1
|
|
32
|
+
- @backstage/plugin-techdocs-common@0.1.2-next.0
|
|
33
|
+
|
|
3
34
|
## 1.19.0-next.0
|
|
4
35
|
|
|
5
36
|
### Minor Changes
|
package/dist/alpha.d.ts
CHANGED
|
@@ -31,8 +31,6 @@ declare const techdocsTranslationRef: _backstage_frontend_plugin_api.Translation
|
|
|
31
31
|
readonly "table.emptyState.docsButton": "DOCS";
|
|
32
32
|
readonly "home.supportButton": "Discover documentation in your ecosystem.";
|
|
33
33
|
readonly "aboutCard.viewTechdocs": "View TechDocs";
|
|
34
|
-
readonly "notFound.title": "Documentation not found";
|
|
35
|
-
readonly "notFound.builderNote": "Note that techdocs.builder is not set to 'local' in your config, which means this Backstage app will not generate docs if they are not found. Make sure the project's docs are generated and published by some external process (e.g. CI/CD pipeline). Or change techdocs.builder to 'local' to generate docs from this Backstage instance.";
|
|
36
34
|
readonly "buildLogs.title": "Build Details";
|
|
37
35
|
readonly "buildLogs.closeDrawer": "Close the drawer";
|
|
38
36
|
readonly "buildLogs.showBuildLogs": "Show Build Logs";
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { useEffect } from 'react';
|
|
2
|
-
import { useEntityList
|
|
2
|
+
import { useEntityList } from '@backstage/plugin-catalog-react';
|
|
3
3
|
import { TECHDOCS_ANNOTATION } from '@backstage/plugin-techdocs-common';
|
|
4
4
|
|
|
5
5
|
class TechDocsFilter {
|
|
6
|
-
|
|
6
|
+
getCatalogQuery() {
|
|
7
7
|
return {
|
|
8
|
-
[`metadata.annotations.${TECHDOCS_ANNOTATION}`]:
|
|
8
|
+
[`metadata.annotations.${TECHDOCS_ANNOTATION}`]: { $exists: true }
|
|
9
9
|
};
|
|
10
10
|
}
|
|
11
11
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TechDocsPicker.esm.js","sources":["../../../src/home/components/TechDocsPicker.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useEffect } from 'react';\nimport {\n
|
|
1
|
+
{"version":3,"file":"TechDocsPicker.esm.js","sources":["../../../src/home/components/TechDocsPicker.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useEffect } from 'react';\nimport { FilterPredicate } from '@backstage/filter-predicates';\nimport {\n DefaultEntityFilters,\n EntityFilter,\n useEntityList,\n} from '@backstage/plugin-catalog-react';\nimport { TECHDOCS_ANNOTATION } from '@backstage/plugin-techdocs-common';\n\nclass TechDocsFilter implements EntityFilter {\n getCatalogQuery(): FilterPredicate {\n return {\n [`metadata.annotations.${TECHDOCS_ANNOTATION}`]: { $exists: true },\n };\n }\n}\n\ntype CustomFilters = DefaultEntityFilters & {\n techdocs?: TechDocsFilter;\n};\n\n/**\n * Component responsible for updating TechDocs filters\n *\n * @public\n */\nexport const TechDocsPicker = () => {\n const { updateFilters } = useEntityList<CustomFilters>();\n\n useEffect(() => {\n updateFilters({\n techdocs: new TechDocsFilter(),\n });\n }, [updateFilters]);\n\n return null;\n};\n"],"names":[],"mappings":";;;;AAyBA,MAAM,cAAA,CAAuC;AAAA,EAC3C,eAAA,GAAmC;AACjC,IAAA,OAAO;AAAA,MACL,CAAC,CAAA,qBAAA,EAAwB,mBAAmB,EAAE,GAAG,EAAE,SAAS,IAAA;AAAK,KACnE;AAAA,EACF;AACF;AAWO,MAAM,iBAAiB,MAAM;AAClC,EAAA,MAAM,EAAE,aAAA,EAAc,GAAI,aAAA,EAA6B;AAEvD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,aAAA,CAAc;AAAA,MACZ,QAAA,EAAU,IAAI,cAAA;AAAe,KAC9B,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,aAAa,CAAC,CAAA;AAElB,EAAA,OAAO,IAAA;AACT;;"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
var name = "@backstage/plugin-techdocs";
|
|
2
|
-
var version = "1.19.0-next.
|
|
2
|
+
var version = "1.19.0-next.2";
|
|
3
3
|
var description = "The Backstage plugin that renders technical documentation for your components";
|
|
4
4
|
var backstage = {
|
|
5
5
|
role: "frontend-plugin",
|
|
@@ -64,6 +64,7 @@ var dependencies = {
|
|
|
64
64
|
"@backstage/core-components": "workspace:^",
|
|
65
65
|
"@backstage/core-plugin-api": "workspace:^",
|
|
66
66
|
"@backstage/errors": "workspace:^",
|
|
67
|
+
"@backstage/filter-predicates": "workspace:^",
|
|
67
68
|
"@backstage/frontend-plugin-api": "workspace:^",
|
|
68
69
|
"@backstage/integration": "workspace:^",
|
|
69
70
|
"@backstage/integration-react": "workspace:^",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"package.json.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -1,36 +1,22 @@
|
|
|
1
1
|
import { jsx } from 'react/jsx-runtime';
|
|
2
2
|
import { useEffect } from 'react';
|
|
3
|
-
import {
|
|
4
|
-
import { useTranslationRef } from '@backstage/core-plugin-api/alpha';
|
|
5
|
-
import { ErrorPage } from '@backstage/core-components';
|
|
3
|
+
import { useApp, useAnalytics } from '@backstage/core-plugin-api';
|
|
6
4
|
import { useTechDocsReaderPage } from '@backstage/plugin-techdocs-react';
|
|
7
5
|
import { useLocation } from 'react-router-dom';
|
|
8
|
-
import { techdocsTranslationRef } from '../../translation.esm.js';
|
|
9
6
|
|
|
10
|
-
const TechDocsNotFound = (
|
|
11
|
-
const
|
|
7
|
+
const TechDocsNotFound = () => {
|
|
8
|
+
const app = useApp();
|
|
9
|
+
const { NotFoundErrorPage } = app.getComponents();
|
|
12
10
|
const analyticsApi = useAnalytics();
|
|
13
11
|
const { entityRef } = useTechDocsReaderPage();
|
|
14
12
|
const location = useLocation();
|
|
15
|
-
const { t } = useTranslationRef(techdocsTranslationRef);
|
|
16
13
|
useEffect(() => {
|
|
17
14
|
const { pathname, search, hash } = location;
|
|
18
15
|
analyticsApi.captureEvent("not-found", `${pathname}${search}${hash}`, {
|
|
19
16
|
attributes: entityRef
|
|
20
17
|
});
|
|
21
18
|
}, [analyticsApi, entityRef, location]);
|
|
22
|
-
|
|
23
|
-
if (![void 0, "local"].includes(techdocsBuilder)) {
|
|
24
|
-
additionalInfo = t("notFound.builderNote");
|
|
25
|
-
}
|
|
26
|
-
return /* @__PURE__ */ jsx(
|
|
27
|
-
ErrorPage,
|
|
28
|
-
{
|
|
29
|
-
status: "404",
|
|
30
|
-
statusMessage: errorMessage || t("notFound.title"),
|
|
31
|
-
additionalInfo
|
|
32
|
-
}
|
|
33
|
-
);
|
|
19
|
+
return /* @__PURE__ */ jsx(NotFoundErrorPage, {});
|
|
34
20
|
};
|
|
35
21
|
|
|
36
22
|
export { TechDocsNotFound };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TechDocsNotFound.esm.js","sources":["../../../src/reader/components/TechDocsNotFound.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useEffect } from 'react';\nimport {
|
|
1
|
+
{"version":3,"file":"TechDocsNotFound.esm.js","sources":["../../../src/reader/components/TechDocsNotFound.tsx"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { useEffect } from 'react';\nimport { useApp, useAnalytics } from '@backstage/core-plugin-api';\nimport { useTechDocsReaderPage } from '@backstage/plugin-techdocs-react';\nimport { useLocation } from 'react-router-dom';\n\nexport const TechDocsNotFound = () => {\n const app = useApp();\n const { NotFoundErrorPage } = app.getComponents();\n const analyticsApi = useAnalytics();\n const { entityRef } = useTechDocsReaderPage();\n const location = useLocation();\n\n useEffect(() => {\n const { pathname, search, hash } = location;\n analyticsApi.captureEvent('not-found', `${pathname}${search}${hash}`, {\n attributes: entityRef,\n });\n }, [analyticsApi, entityRef, location]);\n\n return <NotFoundErrorPage />;\n};\n"],"names":[],"mappings":";;;;;;AAqBO,MAAM,mBAAmB,MAAM;AACpC,EAAA,MAAM,MAAM,MAAA,EAAO;AACnB,EAAA,MAAM,EAAE,iBAAA,EAAkB,GAAI,GAAA,CAAI,aAAA,EAAc;AAChD,EAAA,MAAM,eAAe,YAAA,EAAa;AAClC,EAAA,MAAM,EAAE,SAAA,EAAU,GAAI,qBAAA,EAAsB;AAC5C,EAAA,MAAM,WAAW,WAAA,EAAY;AAE7B,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,EAAE,QAAA,EAAU,MAAA,EAAQ,IAAA,EAAK,GAAI,QAAA;AACnC,IAAA,YAAA,CAAa,YAAA,CAAa,aAAa,CAAA,EAAG,QAAQ,GAAG,MAAM,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI;AAAA,MACpE,UAAA,EAAY;AAAA,KACb,CAAA;AAAA,EACH,CAAA,EAAG,CAAC,YAAA,EAAc,SAAA,EAAW,QAAQ,CAAC,CAAA;AAEtC,EAAA,2BAAQ,iBAAA,EAAA,EAAkB,CAAA;AAC5B;;"}
|
|
@@ -24,13 +24,7 @@ const TechDocsStateIndicator = () => {
|
|
|
24
24
|
let StateAlert = null;
|
|
25
25
|
const classes = useStyles();
|
|
26
26
|
const { t } = useTranslationRef(techdocsTranslationRef);
|
|
27
|
-
const {
|
|
28
|
-
state,
|
|
29
|
-
contentReload,
|
|
30
|
-
contentErrorMessage,
|
|
31
|
-
syncErrorMessage,
|
|
32
|
-
buildLog
|
|
33
|
-
} = useTechDocsReader();
|
|
27
|
+
const { state, contentReload, syncErrorMessage, buildLog } = useTechDocsReader();
|
|
34
28
|
if (state === "INITIAL_BUILD") {
|
|
35
29
|
StateAlert = /* @__PURE__ */ jsx(
|
|
36
30
|
Alert,
|
|
@@ -101,7 +95,7 @@ const TechDocsStateIndicator = () => {
|
|
|
101
95
|
]
|
|
102
96
|
}
|
|
103
97
|
),
|
|
104
|
-
/* @__PURE__ */ jsx(TechDocsNotFound, {
|
|
98
|
+
/* @__PURE__ */ jsx(TechDocsNotFound, {})
|
|
105
99
|
] });
|
|
106
100
|
}
|
|
107
101
|
return StateAlert;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TechDocsStateIndicator.esm.js","sources":["../../../src/reader/components/TechDocsStateIndicator.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport CircularProgress from '@material-ui/core/CircularProgress';\nimport Button from '@material-ui/core/Button';\nimport { makeStyles } from '@material-ui/core/styles';\nimport Alert from '@material-ui/lab/Alert';\nimport { useTranslationRef } from '@backstage/core-plugin-api/alpha';\n\nimport { TechDocsBuildLogs } from './TechDocsBuildLogs';\nimport { TechDocsNotFound } from './TechDocsNotFound';\nimport { useTechDocsReader } from './TechDocsReaderProvider';\nimport { techdocsTranslationRef } from '../../translation';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n marginBottom: theme.spacing(2),\n },\n message: {\n // `word-break: break-word` is deprecated, but gives legacy support to browsers not supporting `overflow-wrap` yet\n // https://developer.mozilla.org/en-US/docs/Web/CSS/word-break\n wordBreak: 'break-word',\n overflowWrap: 'anywhere',\n },\n}));\n\nexport const TechDocsStateIndicator = () => {\n let StateAlert: JSX.Element | null = null;\n const classes = useStyles();\n const { t } = useTranslationRef(techdocsTranslationRef);\n\n const {
|
|
1
|
+
{"version":3,"file":"TechDocsStateIndicator.esm.js","sources":["../../../src/reader/components/TechDocsStateIndicator.tsx"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport CircularProgress from '@material-ui/core/CircularProgress';\nimport Button from '@material-ui/core/Button';\nimport { makeStyles } from '@material-ui/core/styles';\nimport Alert from '@material-ui/lab/Alert';\nimport { useTranslationRef } from '@backstage/core-plugin-api/alpha';\n\nimport { TechDocsBuildLogs } from './TechDocsBuildLogs';\nimport { TechDocsNotFound } from './TechDocsNotFound';\nimport { useTechDocsReader } from './TechDocsReaderProvider';\nimport { techdocsTranslationRef } from '../../translation';\n\nconst useStyles = makeStyles(theme => ({\n root: {\n marginBottom: theme.spacing(2),\n },\n message: {\n // `word-break: break-word` is deprecated, but gives legacy support to browsers not supporting `overflow-wrap` yet\n // https://developer.mozilla.org/en-US/docs/Web/CSS/word-break\n wordBreak: 'break-word',\n overflowWrap: 'anywhere',\n },\n}));\n\nexport const TechDocsStateIndicator = () => {\n let StateAlert: JSX.Element | null = null;\n const classes = useStyles();\n const { t } = useTranslationRef(techdocsTranslationRef);\n\n const { state, contentReload, syncErrorMessage, buildLog } =\n useTechDocsReader();\n\n if (state === 'INITIAL_BUILD') {\n StateAlert = (\n <Alert\n classes={{ root: classes.root }}\n variant=\"outlined\"\n severity=\"info\"\n icon={<CircularProgress size=\"24px\" />}\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n >\n {t('stateIndicator.initialBuild.message')}\n </Alert>\n );\n }\n\n if (state === 'CONTENT_STALE_REFRESHING') {\n StateAlert = (\n <Alert\n variant=\"outlined\"\n severity=\"info\"\n icon={<CircularProgress size=\"24px\" />}\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n classes={{ root: classes.root }}\n >\n {t('stateIndicator.contentStaleRefreshing.message')}\n </Alert>\n );\n }\n\n if (state === 'CONTENT_STALE_READY') {\n StateAlert = (\n <Alert\n variant=\"outlined\"\n severity=\"success\"\n action={\n <Button color=\"inherit\" onClick={() => contentReload()}>\n {t('stateIndicator.contentStaleReady.refreshButton')}\n </Button>\n }\n classes={{ root: classes.root }}\n >\n {t('stateIndicator.contentStaleReady.message')}\n </Alert>\n );\n }\n\n if (state === 'CONTENT_STALE_ERROR') {\n StateAlert = (\n <Alert\n variant=\"outlined\"\n severity=\"error\"\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n classes={{ root: classes.root, message: classes.message }}\n >\n {t('stateIndicator.contentStaleError.message')} {syncErrorMessage}\n </Alert>\n );\n }\n\n if (state === 'CONTENT_NOT_FOUND') {\n StateAlert = (\n <>\n {syncErrorMessage && (\n <Alert\n variant=\"outlined\"\n severity=\"error\"\n action={<TechDocsBuildLogs buildLog={buildLog} />}\n classes={{ root: classes.root, message: classes.message }}\n >\n {t('stateIndicator.contentStaleError.message')} {syncErrorMessage}\n </Alert>\n )}\n <TechDocsNotFound />\n </>\n );\n }\n\n return StateAlert;\n};\n"],"names":[],"mappings":";;;;;;;;;;;AA2BA,MAAM,SAAA,GAAY,WAAW,CAAA,KAAA,MAAU;AAAA,EACrC,IAAA,EAAM;AAAA,IACJ,YAAA,EAAc,KAAA,CAAM,OAAA,CAAQ,CAAC;AAAA,GAC/B;AAAA,EACA,OAAA,EAAS;AAAA;AAAA;AAAA,IAGP,SAAA,EAAW,YAAA;AAAA,IACX,YAAA,EAAc;AAAA;AAElB,CAAA,CAAE,CAAA;AAEK,MAAM,yBAAyB,MAAM;AAC1C,EAAA,IAAI,UAAA,GAAiC,IAAA;AACrC,EAAA,MAAM,UAAU,SAAA,EAAU;AAC1B,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,sBAAsB,CAAA;AAEtD,EAAA,MAAM,EAAE,KAAA,EAAO,aAAA,EAAe,gBAAA,EAAkB,QAAA,KAC9C,iBAAA,EAAkB;AAEpB,EAAA,IAAI,UAAU,eAAA,EAAiB;AAC7B,IAAA,UAAA,mBACE,GAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAA,EAAS,EAAE,IAAA,EAAM,OAAA,CAAQ,IAAA,EAAK;AAAA,QAC9B,OAAA,EAAQ,UAAA;AAAA,QACR,QAAA,EAAS,MAAA;AAAA,QACT,IAAA,kBAAM,GAAA,CAAC,gBAAA,EAAA,EAAiB,IAAA,EAAK,MAAA,EAAO,CAAA;AAAA,QACpC,MAAA,kBAAQ,GAAA,CAAC,iBAAA,EAAA,EAAkB,QAAA,EAAoB,CAAA;AAAA,QAE9C,YAAE,qCAAqC;AAAA;AAAA,KAC1C;AAAA,EAEJ;AAEA,EAAA,IAAI,UAAU,0BAAA,EAA4B;AACxC,IAAA,UAAA,mBACE,GAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAA,EAAQ,UAAA;AAAA,QACR,QAAA,EAAS,MAAA;AAAA,QACT,IAAA,kBAAM,GAAA,CAAC,gBAAA,EAAA,EAAiB,IAAA,EAAK,MAAA,EAAO,CAAA;AAAA,QACpC,MAAA,kBAAQ,GAAA,CAAC,iBAAA,EAAA,EAAkB,QAAA,EAAoB,CAAA;AAAA,QAC/C,OAAA,EAAS,EAAE,IAAA,EAAM,OAAA,CAAQ,IAAA,EAAK;AAAA,QAE7B,YAAE,+CAA+C;AAAA;AAAA,KACpD;AAAA,EAEJ;AAEA,EAAA,IAAI,UAAU,qBAAA,EAAuB;AACnC,IAAA,UAAA,mBACE,GAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAA,EAAQ,UAAA;AAAA,QACR,QAAA,EAAS,SAAA;AAAA,QACT,MAAA,kBACE,GAAA,CAAC,MAAA,EAAA,EAAO,KAAA,EAAM,SAAA,EAAU,OAAA,EAAS,MAAM,aAAA,EAAc,EAClD,QAAA,EAAA,CAAA,CAAE,gDAAgD,CAAA,EACrD,CAAA;AAAA,QAEF,OAAA,EAAS,EAAE,IAAA,EAAM,OAAA,CAAQ,IAAA,EAAK;AAAA,QAE7B,YAAE,0CAA0C;AAAA;AAAA,KAC/C;AAAA,EAEJ;AAEA,EAAA,IAAI,UAAU,qBAAA,EAAuB;AACnC,IAAA,UAAA,mBACE,IAAA;AAAA,MAAC,KAAA;AAAA,MAAA;AAAA,QACC,OAAA,EAAQ,UAAA;AAAA,QACR,QAAA,EAAS,OAAA;AAAA,QACT,MAAA,kBAAQ,GAAA,CAAC,iBAAA,EAAA,EAAkB,QAAA,EAAoB,CAAA;AAAA,QAC/C,SAAS,EAAE,IAAA,EAAM,QAAQ,IAAA,EAAM,OAAA,EAAS,QAAQ,OAAA,EAAQ;AAAA,QAEvD,QAAA,EAAA;AAAA,UAAA,CAAA,CAAE,0CAA0C,CAAA;AAAA,UAAE,GAAA;AAAA,UAAE;AAAA;AAAA;AAAA,KACnD;AAAA,EAEJ;AAEA,EAAA,IAAI,UAAU,mBAAA,EAAqB;AACjC,IAAA,UAAA,mBACE,IAAA,CAAA,QAAA,EAAA,EACG,QAAA,EAAA;AAAA,MAAA,gBAAA,oBACC,IAAA;AAAA,QAAC,KAAA;AAAA,QAAA;AAAA,UACC,OAAA,EAAQ,UAAA;AAAA,UACR,QAAA,EAAS,OAAA;AAAA,UACT,MAAA,kBAAQ,GAAA,CAAC,iBAAA,EAAA,EAAkB,QAAA,EAAoB,CAAA;AAAA,UAC/C,SAAS,EAAE,IAAA,EAAM,QAAQ,IAAA,EAAM,OAAA,EAAS,QAAQ,OAAA,EAAQ;AAAA,UAEvD,QAAA,EAAA;AAAA,YAAA,CAAA,CAAE,0CAA0C,CAAA;AAAA,YAAE,GAAA;AAAA,YAAE;AAAA;AAAA;AAAA,OACnD;AAAA,0BAED,gBAAA,EAAA,EAAiB;AAAA,KAAA,EACpB,CAAA;AAAA,EAEJ;AAEA,EAAA,OAAO,UAAA;AACT;;"}
|
package/dist/translation.esm.js
CHANGED
|
@@ -6,10 +6,6 @@ const techdocsTranslationRef = createTranslationRef({
|
|
|
6
6
|
aboutCard: {
|
|
7
7
|
viewTechdocs: "View TechDocs"
|
|
8
8
|
},
|
|
9
|
-
notFound: {
|
|
10
|
-
title: "Documentation not found",
|
|
11
|
-
builderNote: "Note that techdocs.builder is not set to 'local' in your config, which means this Backstage app will not generate docs if they are not found. Make sure the project's docs are generated and published by some external process (e.g. CI/CD pipeline). Or change techdocs.builder to 'local' to generate docs from this Backstage instance."
|
|
12
|
-
},
|
|
13
9
|
buildLogs: {
|
|
14
10
|
title: "Build Details",
|
|
15
11
|
closeDrawer: "Close the drawer",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"translation.esm.js","sources":["../src/translation.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTranslationRef } from '@backstage/core-plugin-api/alpha';\n\n/** @alpha */\nexport const techdocsTranslationRef = createTranslationRef({\n id: 'techdocs',\n messages: {\n aboutCard: {\n viewTechdocs: 'View TechDocs',\n },\n
|
|
1
|
+
{"version":3,"file":"translation.esm.js","sources":["../src/translation.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createTranslationRef } from '@backstage/core-plugin-api/alpha';\n\n/** @alpha */\nexport const techdocsTranslationRef = createTranslationRef({\n id: 'techdocs',\n messages: {\n aboutCard: {\n viewTechdocs: 'View TechDocs',\n },\n buildLogs: {\n title: 'Build Details',\n closeDrawer: 'Close the drawer',\n showBuildLogs: 'Show Build Logs',\n waitingForLogs: 'Waiting for logs...',\n },\n stateIndicator: {\n initialBuild: {\n message:\n 'Documentation is accessed for the first time and is being prepared. The subsequent loads are much faster.',\n },\n contentStaleRefreshing: {\n message:\n 'A newer version of this documentation is being prepared and will be available shortly.',\n },\n contentStaleReady: {\n message:\n 'A newer version of this documentation is now available, please refresh to view.',\n refreshButton: 'Refresh',\n },\n contentStaleError: {\n message: 'Building a newer version of this documentation failed.',\n },\n },\n redirectNotification: {\n redirectNow: 'Redirect now',\n },\n search: {\n noResults: 'No results found',\n placeholder: 'Search {{entityTitle}} docs',\n },\n readerPageHeader: {\n owner: 'Owner',\n lifecycle: 'Lifecycle',\n source: 'Source',\n },\n home: {\n supportButton: 'Discover documentation in your ecosystem.',\n },\n pageWrapper: {\n title: 'Documentation',\n subtitle: 'Documentation available in {{orgName}}',\n },\n table: {\n columns: {\n document: 'Document',\n owner: 'Owner',\n kind: 'Kind',\n type: 'Type',\n },\n header: {\n actions: 'Actions',\n },\n toolbar: {\n searchPlaceholder: 'Filter',\n },\n pagination: {\n labelRowsSelect: 'rows',\n },\n body: {\n emptyDataSourceMessage: 'No records to display',\n },\n actions: {\n copyDocsUrl: 'Click to copy documentation link to clipboard',\n addToFavorites: 'Add to favorites',\n removeFromFavorites: 'Remove from favorites',\n },\n emptyState: {\n title: 'No documents to show',\n description:\n 'Create your own document. Check out our Getting Started Information',\n docsButton: 'DOCS',\n },\n title: {\n all: 'All',\n },\n },\n error: {\n couldNotLoad: 'Could not load available documentation.',\n },\n nav: {\n title: 'Docs',\n },\n entityContent: {\n title: 'TechDocs',\n },\n reader: {\n settings: 'Settings',\n },\n },\n});\n"],"names":[],"mappings":";;AAmBO,MAAM,yBAAyB,oBAAA,CAAqB;AAAA,EACzD,EAAA,EAAI,UAAA;AAAA,EACJ,QAAA,EAAU;AAAA,IACR,SAAA,EAAW;AAAA,MACT,YAAA,EAAc;AAAA,KAChB;AAAA,IACA,SAAA,EAAW;AAAA,MACT,KAAA,EAAO,eAAA;AAAA,MACP,WAAA,EAAa,kBAAA;AAAA,MACb,aAAA,EAAe,iBAAA;AAAA,MACf,cAAA,EAAgB;AAAA,KAClB;AAAA,IACA,cAAA,EAAgB;AAAA,MACd,YAAA,EAAc;AAAA,QACZ,OAAA,EACE;AAAA,OACJ;AAAA,MACA,sBAAA,EAAwB;AAAA,QACtB,OAAA,EACE;AAAA,OACJ;AAAA,MACA,iBAAA,EAAmB;AAAA,QACjB,OAAA,EACE,iFAAA;AAAA,QACF,aAAA,EAAe;AAAA,OACjB;AAAA,MACA,iBAAA,EAAmB;AAAA,QACjB,OAAA,EAAS;AAAA;AACX,KACF;AAAA,IACA,oBAAA,EAAsB;AAAA,MACpB,WAAA,EAAa;AAAA,KACf;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,SAAA,EAAW,kBAAA;AAAA,MACX,WAAA,EAAa;AAAA,KACf;AAAA,IACA,gBAAA,EAAkB;AAAA,MAChB,KAAA,EAAO,OAAA;AAAA,MACP,SAAA,EAAW,WAAA;AAAA,MACX,MAAA,EAAQ;AAAA,KACV;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,aAAA,EAAe;AAAA,KACjB;AAAA,IACA,WAAA,EAAa;AAAA,MACX,KAAA,EAAO,eAAA;AAAA,MACP,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,KAAA,EAAO;AAAA,MACL,OAAA,EAAS;AAAA,QACP,QAAA,EAAU,UAAA;AAAA,QACV,KAAA,EAAO,OAAA;AAAA,QACP,IAAA,EAAM,MAAA;AAAA,QACN,IAAA,EAAM;AAAA,OACR;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,OAAA,EAAS;AAAA,OACX;AAAA,MACA,OAAA,EAAS;AAAA,QACP,iBAAA,EAAmB;AAAA,OACrB;AAAA,MACA,UAAA,EAAY;AAAA,QACV,eAAA,EAAiB;AAAA,OACnB;AAAA,MACA,IAAA,EAAM;AAAA,QACJ,sBAAA,EAAwB;AAAA,OAC1B;AAAA,MACA,OAAA,EAAS;AAAA,QACP,WAAA,EAAa,+CAAA;AAAA,QACb,cAAA,EAAgB,kBAAA;AAAA,QAChB,mBAAA,EAAqB;AAAA,OACvB;AAAA,MACA,UAAA,EAAY;AAAA,QACV,KAAA,EAAO,sBAAA;AAAA,QACP,WAAA,EACE,qEAAA;AAAA,QACF,UAAA,EAAY;AAAA,OACd;AAAA,MACA,KAAA,EAAO;AAAA,QACL,GAAA,EAAK;AAAA;AACP,KACF;AAAA,IACA,KAAA,EAAO;AAAA,MACL,YAAA,EAAc;AAAA,KAChB;AAAA,IACA,GAAA,EAAK;AAAA,MACH,KAAA,EAAO;AAAA,KACT;AAAA,IACA,aAAA,EAAe;AAAA,MACb,KAAA,EAAO;AAAA,KACT;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,QAAA,EAAU;AAAA;AACZ;AAEJ,CAAC;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs",
|
|
3
|
-
"version": "1.19.0-next.
|
|
3
|
+
"version": "1.19.0-next.2",
|
|
4
4
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -71,23 +71,24 @@
|
|
|
71
71
|
"test": "backstage-cli package test"
|
|
72
72
|
},
|
|
73
73
|
"dependencies": {
|
|
74
|
-
"@backstage/catalog-client": "1.16.3-next.
|
|
74
|
+
"@backstage/catalog-client": "1.16.3-next.1",
|
|
75
75
|
"@backstage/catalog-model": "1.10.2-next.0",
|
|
76
76
|
"@backstage/config": "1.3.10-next.0",
|
|
77
|
-
"@backstage/core-components": "0.18.15-next.
|
|
77
|
+
"@backstage/core-components": "0.18.15-next.3",
|
|
78
78
|
"@backstage/core-plugin-api": "1.12.11-next.0",
|
|
79
79
|
"@backstage/errors": "1.3.2-next.0",
|
|
80
|
-
"@backstage/
|
|
81
|
-
"@backstage/
|
|
80
|
+
"@backstage/filter-predicates": "0.1.6-next.0",
|
|
81
|
+
"@backstage/frontend-plugin-api": "0.18.2-next.1",
|
|
82
|
+
"@backstage/integration": "2.1.3-next.1",
|
|
82
83
|
"@backstage/integration-react": "1.2.23-next.0",
|
|
83
84
|
"@backstage/plugin-auth-react": "0.1.32-next.0",
|
|
84
|
-
"@backstage/plugin-catalog-react": "3.
|
|
85
|
+
"@backstage/plugin-catalog-react": "3.3.0-next.2",
|
|
85
86
|
"@backstage/plugin-search-common": "1.2.26-next.0",
|
|
86
87
|
"@backstage/plugin-search-react": "1.11.9-next.0",
|
|
87
|
-
"@backstage/plugin-techdocs-common": "0.1.
|
|
88
|
-
"@backstage/plugin-techdocs-react": "1.3.16-next.
|
|
88
|
+
"@backstage/plugin-techdocs-common": "0.1.2-next.0",
|
|
89
|
+
"@backstage/plugin-techdocs-react": "1.3.16-next.2",
|
|
89
90
|
"@backstage/theme": "0.7.3",
|
|
90
|
-
"@backstage/ui": "0.
|
|
91
|
+
"@backstage/ui": "0.19.0-next.0",
|
|
91
92
|
"@material-ui/core": "^4.12.2",
|
|
92
93
|
"@material-ui/icons": "^4.9.1",
|
|
93
94
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -103,9 +104,9 @@
|
|
|
103
104
|
},
|
|
104
105
|
"devDependencies": {
|
|
105
106
|
"@backstage/cli": "0.36.7-next.0",
|
|
106
|
-
"@backstage/core-app-api": "1.20.6-next.
|
|
107
|
-
"@backstage/dev-utils": "1.1.28-next.
|
|
108
|
-
"@backstage/plugin-catalog": "2.0.10-next.
|
|
107
|
+
"@backstage/core-app-api": "1.20.6-next.1",
|
|
108
|
+
"@backstage/dev-utils": "1.1.28-next.1",
|
|
109
|
+
"@backstage/plugin-catalog": "2.0.10-next.3",
|
|
109
110
|
"@backstage/plugin-techdocs-module-addons-contrib": "1.1.41-next.0",
|
|
110
111
|
"@backstage/test-utils": "1.7.23-next.0",
|
|
111
112
|
"@testing-library/dom": "^10.0.0",
|