envoyproxy/envoy

Cache filters need some reference documentation

Open

#16 246 ouverte le 30 avr. 2021

Voir sur GitHub
 (4 commentaires) (2 réactions) (0 assignés)C++ (5 373 forks)batch import
area/cachearea/docsarea/protobufenhancementhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez le sandbox existant et la documentation API pour les filtres de cache, puis rédigez une documentation de référence expliquant comment les filtres de cache s'intègrent dans la chaîne de filtres Envoy, leur relation avec envoy.filters.http et comment les étendre. Concentrez vous sur la correction de la documentation API et fournissez un aperçu clair.
Stack technique
cpp
Domaine
backendapidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic understanding of Envoy's filter architecture
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70