Apply suggestions from code review

Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Signed-off-by: Chris <csuich2@gmail.com>
This commit is contained in:
Chris
2025-05-05 10:50:10 -04:00
committed by GitHub
parent 04fd4d2a0c
commit 2314c507be
2 changed files with 2 additions and 2 deletions
+1 -1
View File
@@ -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`.
@@ -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.