From 48ea3d25baeefa74fc56bc1f04cb3237f71d72a1 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Wed, 28 Jul 2021 19:07:17 +0200 Subject: [PATCH] Changesets. Signed-off-by: Eric Peterson --- .changeset/techdocs-give-it-all-back.md | 16 ++++++++++++++++ .changeset/techdocs-if-i-could.md | 10 ++++++++++ 2 files changed, 26 insertions(+) create mode 100644 .changeset/techdocs-give-it-all-back.md create mode 100644 .changeset/techdocs-if-i-could.md diff --git a/.changeset/techdocs-give-it-all-back.md b/.changeset/techdocs-give-it-all-back.md new file mode 100644 index 0000000000..813f88ba87 --- /dev/null +++ b/.changeset/techdocs-give-it-all-back.md @@ -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 diff --git a/.changeset/techdocs-if-i-could.md b/.changeset/techdocs-if-i-could.md new file mode 100644 index 0000000000..e1b04735ed --- /dev/null +++ b/.changeset/techdocs-if-i-could.md @@ -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:` values +are still supported.