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