envoyproxy/envoy

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

Open

#13.167 aperta il 18 set 2020

Vedi su GitHub
 (7 commenti) (2 reazioni) (1 assegnatario)C++ (5373 fork)batch import
area/docshelp wantedpriority/high

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Analizza i punti di estensione tipizzati esistenti nel codebase di Envoy, comprendi il sistema di build Bazel per estrarre i metadati delle estensioni e crea uno script che scarichi tutti i tipi predefiniti e generi automaticamente la documentazione.
Tech stack
cpp
Dominio
documentationbackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
C++Bazel
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60