envoyproxy/envoy

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

Open

#16 328 ouverte le 5 mai 2021

Voir sur GitHub
 (2 commentaires) (0 réactions) (1 assigné)C++ (5 373 forks)batch import
area/docsarea/protobufarea/python codehelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Comprenez l'implémentation actuelle de protodoc et l'utilisation de snippets. Apprenez ce qu'est envoy py binary et en quoi il diffère. Créez ensuite un seul modèle Jinja pour remplacer les snippets et migrez la construction vers envoy py binary.
Stack technique
python
Domaine
toolingbackend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
PythonJinjaPytest
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40