Merge pull request #30984 from Frueber/tech-docs/external-tech-docs-redirect/add-handling-tests-and-documentation

plugins/techdocs-backend/examples/documented-component/catalog-info.yaml

@@ -10,3 +10,17 @@ spec:
   type: service
   lifecycle: experimental
   owner: user:guest
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: techdocs-entity-documented-component
+  title: Example Entity Documented By TechDocs Entity Annotation
+  description: A Service with TechDocs documentation via the `backstage.io/techdocs-entity` annotation.
+  annotations:
+    backstage.io/techdocs-entity: component:default/documented-component
+    backstage.io/techdocs-entity-path: /inner-component-docs
+spec:
+  type: service
+  lifecycle: experimental
+  owner: user:guest

plugins/techdocs-backend/examples/documented-component/docs/inner-component-docs/index.md

@@ -0,0 +1,5 @@
+# Inner Component Docs
+
+This is a basic example of documentation within a larger suite of TechDocs that can be referenced by whatever entities necessary. It is intended as a showcase of the `backstage.io/techdocs-entity-path` annotation for linking to a "subpage" in TechDocs that are declared by another entity.
+
+Please review the [How-To Guides - Deep Linking Into TechDocs](../../../../../../docs/features/techdocs/how-to-guides.md#deep-linking-into-techdocs) section for more information and you can view the example usage on the "Example Entity Documented By TechDocs Entity Annotation" component in this [catalog-info.yaml](../../catalog-info.yaml) file.

plugins/techdocs-backend/examples/documented-component/mkdocs.yml

@@ -7,6 +7,7 @@ nav:
   - Subpage: sub-page.md
   - 'Code Sample': code/code-sample.md
   - Extensions: extensions.md
+  - 'Inner Component Docs': inner-component-docs/index.md
 
 plugins:
   - techdocs-core