envoyproxy/envoy

Cache filters need some reference documentation

Open

#16,246 创建于 2021年4月30日

在 GitHub 查看
 (4 评论) (2 反应) (0 负责人)C++ (5,373 fork)batch import
area/cachearea/docsarea/protobufenhancementhelp wanted

仓库指标

Star
 (27,997 star)
PR 合并指标
 (平均合并 8天) (30 天内合并 378 个 PR)

描述

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

贡献者指南

研究方向
查看现有的沙箱和缓存过滤器的 API 文档，然后起草参考文档，解释缓存过滤器如何融入 Envoy 的过滤器链，与 envoy.filters.http 的关系，以及如何扩展它们。重点纠正 API 文档并提供清晰的概述。
技术栈
cpp
领域
backendapidocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Basic understanding of Envoy's filter architecture
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70