envoyproxy/envoy

Automate generation of docker image table in docs

Open

#13.755 aperta il 26 ott 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)C++ (5373 fork)batch import
area/docsenhancementhelp wanted

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

description

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

This should be generated automatically according to tag/branch

Guida contributor

Direzione di ricerca
Il problema mira ad automatizzare la generazione di una tabella di immagini Docker nella documentazione. Attualmente, la tabella è hardcoded come introdotto nella PR #13490. La soluzione dovrebbe generare automaticamente questa tabella in base al tag o al ramo corrente. Indagare come funziona il processo di build della documentazione (ad esempio, Sphinx o simili) e individuare dove è definita la tabella hardcoded. Uno script (probabilmente in Python o shell) dovrebbe estrarre le immagini Docker disponibili dal sistema di build e generare la corrispondente tabella RST o markdown. Considerare il riferimento agli script di build esistenti nel repository, come quelli nelle directory 'ci' o 'docs'.
Tech stack
Nessuno
Dominio
documentationdevops
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitDocker
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65