envoyproxy/envoy

Move protodoc to `envoy_py_binary` and use a single jinja template to render

Open

#16.328 aperta il 5 mag 2021

Vedi su GitHub
 (2 commenti) (0 reazioni) (1 assegnatario)C++ (5373 fork)batch import
area/docsarea/protobufarea/python codehelp wanted

Metriche repository

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

Descrizione

description

protodoc will benefit quite a lot from moving to the newer envoy_py_binary format and moving tests to pytest

what would also greatly simplify the code is using the existing visitor pattern to collect up a py dictionary of the page structure and injecting that to a single template, rather than lots of snippets and \n workarounds

Guida contributor

Direzione di ricerca
Comprendi l'attuale implementazione di protodoc e l'uso di snippet. Scopri cosa è envoy py binary e come differisce. Quindi crea un singolo template Jinja per sostituire gli snippet e sposta la build su envoy py binary.
Tech stack
python
Dominio
toolingbackend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
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
PythonJinjaPytest
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40