envoyproxy/envoy

docs: automate listing all stock/built-in types for typed extensions

Open

#13 167 ouverte le 18 sept. 2020

Voir sur GitHub
 (7 commentaires) (2 réactions) (1 assigné)C++ (5 373 forks)batch import
area/docshelp wantedpriority/high

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

A major problem with our documentation is the user does not know what types are available for all of the typed extension points. Obviously we can't know all custom extensions and all bets are off if the user is doing a custom build, but we can ignore those cases because those users won't have any issues.

For everyone else, I think we should:

  1. Dump out all extensions in the stock build (either do this with bazel ahead of time, or somehow dump it out of the final exe). This is a map of extension type/category/link to docs, etc.
  2. Automate the documentation so all typed_extensions are printed with docs listing all stock types, as well as links to relevant docs, as well as sample config.

Guide contributeur

Direction de recherche
Examinez les points d'extension typés existants dans la base de code d'Envoy, comprenez le système de build Bazel pour extraire les métadonnées des extensions et créez un script qui vide tous les types intégrés et génère automatiquement la documentation.
Stack technique
cpp
Domaine
documentationbackend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
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
C++Bazel
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60