Skip to main content

Add documentation to a component

A component without documentation says so on its Docs tab. One annotation in its catalog-info.yaml file connects it to the documentation in its repository.

Before you start​

  • The component is in the catalog.
  • Its repository holds a mkdocs.yml file and a docs folder.

Add the annotation​

  1. In the repository of the component, open catalog-info.yaml.
  2. Under metadata, add the annotation backstage.io/techdocs-ref:
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: order-service
  annotations:
    backstage.io/techdocs-ref: dir:.
spec:
  type: service
  owner: platform-team
  1. Save and push the file.

Once Astrolabe has read the file again, the Docs tab of the component shows the documentation, and the component appears in the Documentation page.

This step was not checked on a live instance.

✅ That's it!