envoyproxy/envoy

In docs, make use of version_added, version_changed, deprecated etc sphinx directives

Open

#15.763 aperta il 30 mar 2021

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docsarea/protobufenhancementhelp wanted

Metriche repository

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

Descrizione

description

if we included in the documentation the version information - ie when added, changed, deprecated or removed it would be very helpful for users.

it would also might make it clearer why problems coming from version/configuration mis/matches do/not work

i think we can get most of this information from protos - not sure immediately how we show removed - but that would be v helpful when upgrading

Guida contributor

Direzione di ricerca
Prendi familiarità con la struttura della documentazione del progetto e Sphinx. Esamina i file proto per identificare i campi version added, version changed, deprecated e removed. Quindi aggiungi le direttive appropriate ai file di documentazione.
Tech stack
cpp
Dominio
documentation
Tipo issue
Documentazione
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
SphinxGitprotobuf
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75