envoyproxy/envoy

Move protodoc to `envoy_py_binary` and use a single jinja template to render

Open

#16,328 opened on 2021年5月5日

GitHub で見る
 (2 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
area/docsarea/protobufarea/python codehelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (平均マージ 8d) (30d で 378 merged PRs)

説明

description

protodoc will benefit quite a lot from moving to the newer envoy_py_binary format and moving tests to pytest

what would also greatly simplify the code is using the existing visitor pattern to collect up a py dictionary of the page structure and injecting that to a single template, rather than lots of snippets and \n workarounds

コントリビューターガイド

調査方針
現在のprotodocの実装とそのスニペットの使用方法を理解します。envoy py binaryとその違いを学びます。次に、単一のJinjaテンプレートを作成してスニペットを置き換え、ビルドをenvoy py binaryに移行します。
技術スタック
python
領域
toolingbackend
Issue 種別
リファクタリング
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
PythonJinjaPytest
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40