From c1de2a809a9f07a9b7be3b6299534d06b57b1f7c Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Thu, 11 Mar 2021 23:26:38 +0100 Subject: [PATCH] docs: Add TechDocs FAQ about annotation value when using external build and storage Signed-off-by: Himanshu Mishra --- docs/features/techdocs/FAQ.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/features/techdocs/FAQ.md b/docs/features/techdocs/FAQ.md index de424778cb..5ce71ebfad 100644 --- a/docs/features/techdocs/FAQ.md +++ b/docs/features/techdocs/FAQ.md @@ -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.