envoyproxy/envoy

Automate generation of docker image table in docs

Open

#13 755 ouverte le 26 oct. 2020

Voir sur GitHub
 (0 commentaires) (0 réactions) (1 assigné)C++ (5 373 forks)batch import
area/docsenhancementhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

description

When we landed #13490 it hardcoded the availablle docker images.

This should be generated automatically according to tag/branch

Guide contributeur

Direction de recherche
Le problème vise à automatiser la génération d'un tableau d'images Docker dans la documentation. Actuellement, le tableau est codé en dur comme introduit dans la PR #13490. La solution doit générer automatiquement ce tableau en fonction de l'étiquette ou de la branche actuelle. Étudiez le fonctionnement du processus de construction de la documentation (par exemple, Sphinx ou similaire) et localisez où le tableau codé en dur est défini. Un script (probablement en Python ou en shell) doit extraire les images Docker disponibles du système de construction et générer le tableau RST ou markdown correspondant. Envisagez de vous référer aux scripts de construction existants dans le dépôt, tels que ceux dans les répertoires 'ci' ou 'docs'.
Stack technique
Aucun
Domaine
documentationdevops
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitDocker
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65