Improving the messaging around the README.md/index.md bugfix.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-04-14 12:26:34 +02:00
parent 3350640147
commit 733187987b
3 changed files with 26 additions and 10 deletions
+1 -10
View File
@@ -1,14 +1,5 @@
---
'@techdocs/cli': minor
'@backstage/plugin-techdocs-backend': minor
'@backstage/plugin-techdocs-node': minor
---
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`:
```yaml
techdocs:
generator:
mkdocs:
legacyCopyReadmeMdToIndexMd: true
```
Removed an undocumented, broken behavior where `README.md` files would be copied to `index.md` if it did not exist, leading to broken links in the TechDocs UI.
@@ -0,0 +1,14 @@
---
'@backstage/plugin-techdocs-backend': minor
---
Removed an undocumented, broken behavior where `README.md` files would be copied to `index.md` if it did not exist, leading to broken links in the TechDocs UI.
**WARNING**: If you notice 404s in TechDocs after updating, check to make sure that all markdown files referenced in your `mkdocs.yml`s' `nav` sections exist. The following configuration may be used to temporarily revert to the broken behavior.
```yaml
techdocs:
generator:
mkdocs:
legacyCopyReadmeMdToIndexMd: true
```
@@ -0,0 +1,11 @@
---
'@techdocs/cli': minor
---
Removed an undocumented, broken behavior where `README.md` files would be copied to `index.md` if it did not exist, leading to broken links in the TechDocs UI.
**WARNING**: If you notice 404s in TechDocs after updating, check to make sure that all markdown files referenced in your `mkdocs.yml`s' `nav` sections exist. The following flag may be passed to the `generate` command to temporarily revert to the broken behavior.
```sh
techdocs-cli generate --legacyCopyReadmeMdToIndexMd
```