envoyproxy/envoy

Cache filters need some reference documentation

Open

#16.246 geöffnet am 30. Apr. 2021

Auf GitHub ansehen
 (4 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/cachearea/docsarea/protobufenhancementhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Sandbox und API Dokumentation für Cache Filter und erstellen Sie dann eine Referenzdokumentation, die erklärt, wie Cache Filter in die Envoy Filterkette passen, ihre Beziehung zu envoy.filters.http und wie sie erweitert werden können. Konzentrieren Sie sich auf die Korrektur der API Dokumentation und die Bereitstellung einer klaren Übersicht.
Tech Stack
cpp
Domain
backendapidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic understanding of Envoy's filter architecture
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70