envoyproxy/envoy

Cache filters need some reference documentation

Open

#16.246 aperta il 30 apr 2021

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

Metriche repository

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

Descrizione

description

There is currently a sandbox and some minimal api documentation for the cache filters/extensions

The api docs are currently wrong (they are showing the wrong relationship between these and envoy.filters.http)

What is desperately needed is some reference documentation that explains how these fit together and potentially could be extended

Guida contributor

Direzione di ricerca
Esamina la sandbox esistente e la documentazione API per i filtri cache, quindi redige la documentazione di riferimento che spiega come i filtri cache si inseriscono nella catena di filtri di Envoy, la loro relazione con envoy.filters.http e come estenderli. Concentrati sulla correzione della documentazione API e fornisci una panoramica chiara.
Tech stack
cpp
Dominio
backendapidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic understanding of Envoy's filter architecture
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70