envoyproxy/envoy

Snap docs/configs/image versions

Open

#6.361 geöffnet am 22. März 2019

Auf GitHub ansehen
 (11 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docshelp wantedpriority/high

Repository-Metriken

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

Beschreibung

Related to https://github.com/envoyproxy/envoy/pull/6357. We have two different user bases:

  1. People that run master
  2. People that run tagged versions

We need to do a better job of having a consistent state that works for people. I think this will involve setting up some templating so that when we build the docs, we snap to a specific SHA for everything, including the image tags. This will need more thought since some of our references to latest are checked into code (so maybe some of the Docker files also need to be generated.)

Contributor Guide

Research-Richtung
Das Issue verweist auf PR #6357 und erörtert die Notwendigkeit, Docs/Configs für sowohl Master als auch getaggte Versionen auf bestimmte SHAs festzulegen. Derzeit sind Verweise auf 'latest' im Code eingecheckt, was Templating und möglicherweise die Generierung von Docker Dateien erfordert. Untersuchen Sie zunächst das vorhandene Build System im Repository, insbesondere die Dockerfiles und die Dokumentationsgenerierungsskripte. Sehen Sie sich verwandte Kommentare zu spezifischen Problemstellen an. Das Ziel ist, eine Templating Lösung vorzuschlagen, die einen konsistenten Zustand über verschiedene Nutzerbasen hinweg sicherstellt.
Tech Stack
cppdocker
Domain
documentationdevopsbuild system
Issue Type
Wartung
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.
Halber Tag
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.
Meist klar
Voraussetzungen
GitDocker
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60