envoyproxy/envoy

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

Open

#13,167 opened on 2020年9月18日

GitHub で見る
 (7 comments) (2 reactions) (1 assignee)C++ (5,373 forks)batch import
area/docshelp wantedpriority/high

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (平均マージ 8d) (30d で 378 merged PRs)

説明

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.

コントリビューターガイド