Aller au contenu principal

Lire le README d'un composant

La carte README affiche, sur la vue d'ensemble d'un composant, le README à la racine de son dépôt. Tu lis comment installer et lancer le composant sans quitter Astrolabe.

Avant de commencer​

  • Le plugin Stack technique est allumé : la carte README vient avec lui. Un administrateur l'allume dans Administration › Plugins : voir Allumer un plugin.
  • Le composant est dans le catalogue et pointe vers son dépôt. L'hôte du dépôt a une intégration dans Administration › Connexions de l'entreprise.

📖 Ouvrir la carte​

  1. Dans la barre du haut, clique sur Catalogue.

  2. Dans la liste, clique sur le nom de ton composant, par exemple mon-appli-web.

  3. L'onglet Vue d'ensemble s'ouvre. La carte README est sous la carte À propos.

  4. La carte affiche le README de la branche par défaut, par exemple main. Les liens et les images du README s'ouvrent sur l'hôte du dépôt.

  5. Pour lire le fichier sur l'hôte, clique sur Ouvrir dans le dépôt, en haut à droite de la carte.

🔎 Quel fichier la carte affiche​

La carte lit la racine du dépôt, sur sa branche par défaut, et affiche le premier fichier trouvé parmi README.md, README.rst, README.txt et README. Un README.md est mis en forme ; les autres s'affichent tels qu'ils sont écrits.

Un README très long est coupé. La carte dit alors Ce README est plus long que ce que la carte affiche : ouvrez-le dans le dépôt pour lire la suite.

La carte lit le dépôt avec l'intégration de l'entreprise, comme le catalogue. Tu ne vois que le README d'un composant que tu as le droit de voir dans le catalogue.

🛠 Dépannage​

Ce que tu voisQue faire
Aucun README à la racine du dépôt. et Cherché : README.md, README.rst, README.txt et README sur la branche main.Ajoute un README.md à la racine du dépôt, sur sa branche par défaut. La carte l'affiche à la visite suivante.
Le dépôt de ce composant n'existe pas sur … avec Vérifie l'annotation backstage.io/source-location du composant : le dépôt a peut-être été renommé, déplacé ou supprimé.Corrige l'annotation backstage.io/source-location dans le catalog-info.yaml du composant, pour qu'elle pointe vers le dépôt.
Pas de carte README sur la vue d'ensembleLe composant n'a pas d'annotation backstage.io/source-location qui pointe vers un dépôt, ou le plugin Stack technique est éteint.

✅ C'est fait !

Suite : Problèmes courants avec la Stack technique.