envoyproxy/envoy

Automate generation of docker image table in docs

Open

#13.755 geöffnet am 26. Okt. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (5.373 Forks)batch import
area/docsenhancementhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

description

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

This should be generated automatically according to tag/branch

Contributor Guide

Research-Richtung
Das Problem zielt darauf ab, die Generierung einer Docker Image Tabelle in der Dokumentation zu automatisieren. Derzeit ist die Tabelle hartkodiert, wie in PR #13490 eingeführt. Die Lösung sollte diese Tabelle automatisch basierend auf dem aktuellen Tag oder Branch generieren. Untersuchen Sie, wie der Dokumentations Build Prozess funktioniert (z. B. Sphinx oder ähnliches), und finden Sie heraus, wo die hartkodierte Tabelle definiert ist. Ein Skript (wahrscheinlich in Python oder Shell) sollte verfügbare Docker Images aus dem Build System extrahieren und die entsprechende RST oder Markdown Tabelle generieren. Ziehen Sie in Betracht, auf vorhandene Build Skripte im Repository zu verweisen, wie z. B. die in den Verzeichnissen 'ci' oder 'docs'.
Tech Stack
Keine
Domain
documentationdevops
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitDocker
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65