Using Annotations CBA Practice Questions (Page 1)

Questions 1–5

1. 1foundation · easy

   Which value is appropriate for the `backstage.io/techdocs-ref` annotation?

   • AThe email address of the documentation owner
   • BThe name of the documentation site, such as my-docs-site
   • CA boolean value such as true or false to enable TechDocs
   • DA URL or path pointing to the documentation source, such as url:https://example.com/docs or dir:./docs
   Reveal Solution Discussion Select an answer first
2. 2expert · hard

   A platform engineer is troubleshooting why a catalog entity's TechDocs tab is empty. The entity has the annotation 'backstage.io/techdocs-ref: url:https://raw.githubusercontent.com/org/repo/main/docs'. The URL is accessible from the engineer's browser. What is the most likely reason the docs are not rendering?

   • AThe annotation key is incorrect.
   • BThe Backstage backend cannot access the URL due to network restrictions.
   • CThe entity needs a 'github.com/project-slug' annotation.
   • DThe URL must be a 'dir:' reference.
   Reveal Solution Discussion Select an answer first
4. 3application · medium

   A team wants to use Backstage to manage documentation for multiple services. They have a monorepo with each service in a separate folder. Each service has its own 'docs/' directory. How should they configure the 'backstage.io/techdocs-ref' annotation for each service entity?

   • AUse 'file:service-a/docs/index.md' for each service.
   • BUse 'dir:.' for all services.
   • CUse 'url:https://github.com/org/repo/tree/main/service-a/docs' for each service.
   • DUse 'dir:service-a/docs' for each service.
   Reveal Solution Discussion Select an answer first
5. 4foundation · easy

   Which annotation key is commonly used to link a catalog entity to its source code repository?

   • Abackstage.io/techdocs-ref
   • Bbackstage.io/owner
   • Cgithub.com/project-slug
   • Dbackstage.io/managed-by-location
   Reveal Solution Discussion Select an answer first
6. 5application · medium

   A team uses Backstage to manage their microservices. They want the 'TechDocs' tab to show documentation for each service. They have a monorepo with the following structure: 'services/service-a/docs/' and 'services/service-b/docs/'. What should the 'backstage.io/techdocs-ref' annotation be for the 'service-a' entity?

   • Afile:services/service-a/docs/index.md
   • Bdir:.
   • Curl:https://github.com/org/repo/tree/main/services/service-a/docs
   • Ddir:services/service-a/docs
   Reveal Solution Discussion Select an answer first