envoyproxy/envoy

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

Open

#16,328 opened on May 5, 2021

View on 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
 (Avg merge 8d) (378 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Understand the current protodoc implementation and its use of snippets. Learn about envoy py binary and how it differs. Then create a single Jinja template to replace the snippets and move the build to envoy py binary.
Tech stack
python
Domain
toolingbackend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonJinjaPytest
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40