envoyproxy/envoy

Cache filters need some reference documentation

Open

#16,246 opened on 2021年4月30日

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
 (平均マージ 8d) (30d で 378 merged PRs)

説明

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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Basic understanding of Envoy's filter architecture
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70