paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 24 Packages Projects Releases Wiki Activity

docs: Add TechDocs FAQ about annotation value when using external build and storage

Browse Source 
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
This commit is contained in:
Himanshu Mishra
2021-03-11 23:26:38 +01:00
parent e07b41751e
commit c1de2a809a
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/FAQ.md
+11
View File
@@ -34,3 +34,14 @@ Not right now. We are currently using MkDocs to generate the documentation from
source, so the files have to be in Markdown format. However, in the future we
want to support other static site generators which will make it possible to use
other file formats.
#### What should be the value of `backstage.io/techdocs-ref` when using external build and storage?
The value of
[`backstage.io/techdocs-ref`](../software-catalog/well-known-annotations.md#backstageiotechdocs-ref)
metadata annotation is used in the build process of TechDocs. But when
[`techdocs.builder`](./configuration.md) is set to `'external'` in
`app-config.yaml`, the value of the annotation remains unused. However the
annotation should still be present in entity descriptor file (e.g.
`catalog-info.yaml`) for Backstage to know that TechDocs is enabled for the
entity.