envoyproxy/envoy

Snap docs/configs/image versions

Open

#6361 aperta il 22 mar 2019

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docshelp wantedpriority/high

Metriche repository

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

Descrizione

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.)

Guida contributor

Direzione di ricerca
Il problema fa riferimento alla PR #6357 e discute la necessità di agganciare documenti/configurazioni a SHA specifici sia per la versione master che per quelle taggate. Attualmente, i riferimenti a 'latest' sono inseriti nel codice, richiedendo la creazione di template e possibilmente la generazione di file Docker. Per iniziare, esamina il sistema di build esistente nel repository, in particolare i Dockerfile e gli script di generazione della documentazione. Cerca nei commenti correlati i punti critici specifici. L'obiettivo è proporre una soluzione di templating che garantisca uno stato coerente tra le diverse basi utenti.
Tech stack
cppdocker
Dominio
documentationdevopsbuild system
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitDocker
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60