Changesets.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2021-07-28 19:07:17 +02:00
parent 8ef28f5dbc
commit 48ea3d25ba
2 changed files with 26 additions and 0 deletions
+16
View File
@@ -0,0 +1,16 @@
---
'@backstage/techdocs-common': minor
---
TechDocs has dropped all support for the long-ago deprecated git-based common
prepares as well as all corresponding values in `backstage.io/techdocs-ref`
annotations.
Entities whose `backstage.io/techdocs-ref` annotation values still begin with
`github:`, `gitlab:`, `bitbucket:`, or `azure/api:` will no longer be generated
by TechDocs. Be sure to update these values so that they align with their
expected format and your usage of TechDocs.
For details, see [this explainer on TechDocs ref annotation values][how].
[how]: https://backstage.io/docs/features/techdocs/how-to-guides#how-to-understand-techdocs-ref-annotation-values
+10
View File
@@ -0,0 +1,10 @@
---
'@backstage/plugin-techdocs-backend': patch
'@backstage/plugin-scaffolder-backend': patch
'@backstage/create-app': patch
---
The recommended value for a `backstage.io/techdocs-ref` annotation is now
`dir:.`, indicating "documentation source files are located in the same
directory relative to the catalog entity." Note that `url:<location>` values
are still supported.