Aller au contenu principal

Ajouter une documentation à un composant

Un composant sans documentation le dit dans son onglet Documentation. Une annotation dans son fichier catalog-info.yaml le relie à la documentation de son dépôt.

Avant de commencer​

  • Le composant est dans le catalogue.
  • Son dépôt contient un fichier mkdocs.yml et un dossier docs.

Ajouter l'annotation​

  1. Dans le dépôt du composant, ouvre catalog-info.yaml.
  2. Sous metadata, ajoute l'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. Enregistre et pousse le fichier.

Une fois qu'Astrolabe a relu le fichier, l'onglet Documentation du composant montre la documentation, et le composant apparaît dans la page Documentation.

Cette étape n'a pas été vérifiée sur une instance.

✅ C'est tout !