envoyproxy/envoy

Cache filters need some reference documentation

Open

#16,246 opened on Apr 30, 2021

View on GitHub
 (4 comments) (2 reactions) (0 assignees)C++ (5,373 forks)batch import
area/cachearea/docsarea/protobufenhancementhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

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

Contributor guide

Research direction
Review the existing sandbox and API docs for cache filters, then draft reference documentation explaining how cache filters fit into Envoy's filter chain, their relationship with envoy.filters.http, and how to extend them. Focus on correcting the API docs and providing a clear overview.
Tech stack
cpp
Domain
backendapidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic understanding of Envoy's filter architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70