@backstage/plugin-techdocs-backend 0.0.0-nightly-20220405023238 → 0.0.0-nightly-20220408023622
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 +20 -9
- package/config.d.ts +14 -0
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,20 +1,31 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-backend
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20220408023622
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- bcf1a2496c: BREAKING: The default Techdocs behavior will no longer attempt to copy `docs/README.md` or `README.md` to `docs/index.md` (if not found). To retain this behavior in your instance, you can set the following config in your `app-config.yaml`:
|
|
8
|
+
|
|
9
|
+
```yaml
|
|
10
|
+
techdocs:
|
|
11
|
+
generator:
|
|
12
|
+
mkdocs:
|
|
13
|
+
legacyCopyReadmeMdToIndexMd: true
|
|
14
|
+
```
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
|
6
17
|
|
|
7
18
|
- ada4446733: Specify type of `visibilityPermission` property on collators and collator factories.
|
|
8
19
|
- 7762d54200: Fixed a bug affecting those with cache enabled that would result in empty content being cached if the first attempt to load a static asset from storage were made via a `HEAD` request, rather than a `GET` request.
|
|
9
20
|
- Updated dependencies
|
|
10
|
-
- @backstage/integration@0.0.0-nightly-
|
|
11
|
-
- @backstage/plugin-permission-common@0.0.0-nightly-
|
|
12
|
-
- @backstage/catalog-model@0.0.0-nightly-
|
|
13
|
-
- @backstage/plugin-search-common@0.0.0-nightly-
|
|
14
|
-
- @backstage/plugin-catalog-common@0.0.0-nightly-
|
|
15
|
-
- @backstage/backend-common@0.0.0-nightly-
|
|
16
|
-
- @backstage/
|
|
17
|
-
- @backstage/
|
|
21
|
+
- @backstage/integration@0.0.0-nightly-20220408023622
|
|
22
|
+
- @backstage/plugin-permission-common@0.0.0-nightly-20220408023622
|
|
23
|
+
- @backstage/catalog-model@0.0.0-nightly-20220408023622
|
|
24
|
+
- @backstage/plugin-search-common@0.0.0-nightly-20220408023622
|
|
25
|
+
- @backstage/plugin-catalog-common@0.0.0-nightly-20220408023622
|
|
26
|
+
- @backstage/backend-common@0.0.0-nightly-20220408023622
|
|
27
|
+
- @backstage/plugin-techdocs-node@0.0.0-nightly-20220408023622
|
|
28
|
+
- @backstage/catalog-client@0.0.0-nightly-20220408023622
|
|
18
29
|
|
|
19
30
|
## 1.0.1-next.1
|
|
20
31
|
|
package/config.d.ts
CHANGED
|
@@ -44,6 +44,20 @@ export interface Config {
|
|
|
44
44
|
* Pull the latest docker image
|
|
45
45
|
*/
|
|
46
46
|
pullImage?: boolean;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Override behavior specific to mkdocs.
|
|
50
|
+
*/
|
|
51
|
+
mkdocs?: {
|
|
52
|
+
/**
|
|
53
|
+
* (Optional and not recommended) Configures the techdocs generator to
|
|
54
|
+
* attempt to ensure an index.md exists falling back to using <docs-dir>/README.md
|
|
55
|
+
* or README.md in case a default <docs-dir>/index.md is not provided.
|
|
56
|
+
* Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior
|
|
57
|
+
* will be broken in these scenarios.
|
|
58
|
+
*/
|
|
59
|
+
legacyCopyReadmeMdToIndexMd?: boolean;
|
|
60
|
+
};
|
|
47
61
|
};
|
|
48
62
|
|
|
49
63
|
/**
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-backend",
|
|
3
3
|
"description": "The Backstage backend plugin that renders technical documentation for your components",
|
|
4
|
-
"version": "0.0.0-nightly-
|
|
4
|
+
"version": "0.0.0-nightly-20220408023622",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -34,16 +34,16 @@
|
|
|
34
34
|
"clean": "backstage-cli package clean"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.0.0-nightly-
|
|
38
|
-
"@backstage/catalog-client": "^0.0.0-nightly-
|
|
39
|
-
"@backstage/catalog-model": "^0.0.0-nightly-
|
|
37
|
+
"@backstage/backend-common": "^0.0.0-nightly-20220408023622",
|
|
38
|
+
"@backstage/catalog-client": "^0.0.0-nightly-20220408023622",
|
|
39
|
+
"@backstage/catalog-model": "^0.0.0-nightly-20220408023622",
|
|
40
40
|
"@backstage/config": "^1.0.0",
|
|
41
41
|
"@backstage/errors": "^1.0.0",
|
|
42
|
-
"@backstage/integration": "^0.0.0-nightly-
|
|
43
|
-
"@backstage/plugin-catalog-common": "^0.0.0-nightly-
|
|
44
|
-
"@backstage/plugin-permission-common": "^0.0.0-nightly-
|
|
45
|
-
"@backstage/plugin-search-common": "^0.0.0-nightly-
|
|
46
|
-
"@backstage/plugin-techdocs-node": "^0.0.0-nightly-
|
|
42
|
+
"@backstage/integration": "^0.0.0-nightly-20220408023622",
|
|
43
|
+
"@backstage/plugin-catalog-common": "^0.0.0-nightly-20220408023622",
|
|
44
|
+
"@backstage/plugin-permission-common": "^0.0.0-nightly-20220408023622",
|
|
45
|
+
"@backstage/plugin-search-common": "^0.0.0-nightly-20220408023622",
|
|
46
|
+
"@backstage/plugin-techdocs-node": "^0.0.0-nightly-20220408023622",
|
|
47
47
|
"@types/express": "^4.17.6",
|
|
48
48
|
"dockerode": "^3.3.1",
|
|
49
49
|
"express": "^4.17.1",
|
|
@@ -56,9 +56,9 @@
|
|
|
56
56
|
"winston": "^3.2.1"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"@backstage/backend-test-utils": "^0.0.0-nightly-
|
|
60
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
61
|
-
"@backstage/plugin-search-backend-node": "0.0.0-nightly-
|
|
59
|
+
"@backstage/backend-test-utils": "^0.0.0-nightly-20220408023622",
|
|
60
|
+
"@backstage/cli": "^0.0.0-nightly-20220408023622",
|
|
61
|
+
"@backstage/plugin-search-backend-node": "0.0.0-nightly-20220408023622",
|
|
62
62
|
"@types/dockerode": "^3.3.0",
|
|
63
63
|
"msw": "^0.35.0",
|
|
64
64
|
"supertest": "^6.1.3"
|