From 2314c507be97d1731e72058ba81034039643a500 Mon Sep 17 00:00:00 2001 From: Chris Date: Mon, 5 May 2025 10:50:10 -0400 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Chris --- .changeset/smooth-eels-think.md | 2 +- docs/features/software-catalog/well-known-annotations.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/smooth-eels-think.md b/.changeset/smooth-eels-think.md index ddae6dc151..c5e2fe0c85 100644 --- a/.changeset/smooth-eels-think.md +++ b/.changeset/smooth-eels-think.md @@ -5,4 +5,4 @@ '@backstage/plugin-techdocs-common': patch --- -Introduced "backstage.io/techdocs-entity-path" annotation which allows deep linking into another entities TechDocs in conjunction with "backstage.io/techdocs-entity". +Introduced `backstage.io/techdocs-entity-path` annotation which allows deep linking into another entities TechDocs in conjunction with `backstage.io/techdocs-entity`. diff --git a/docs/features/software-catalog/well-known-annotations.md b/docs/features/software-catalog/well-known-annotations.md index 4e2801197f..42cefd3adb 100644 --- a/docs/features/software-catalog/well-known-annotations.md +++ b/docs/features/software-catalog/well-known-annotations.md @@ -125,7 +125,7 @@ metadata: backstage.io/techdocs-entity-path: /path/to/this/component ``` -The value of this annotation informs of the path to this components TechDocs within an external entity that owns the TechDocs. +The value of this annotation informs of the path to this component's TechDocs within an external entity that owns the TechDocs. In conjunction with [backstage.io/techdocs-entity](#backstageiotechdocs-entity) this allows for deep linking into the TechDocs of another entity, not just linking to the root of another entities TechDocs.