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