envoyproxy/envoy

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

Open

#16,328 建立於 2021年5月5日

在 GitHub 查看
 (2 留言) (0 反應) (1 負責人)C++ (5,373 fork)batch import
area/docsarea/protobufarea/python codehelp wanted

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

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
議題類型
重構
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
PythonJinjaPytest
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40