envoyproxy / envoyproxy/envoy

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

Open
#13,167 7 comments 2 reactions 1 assignee Claimed by @phlax View on GitHub
area/docs help wanted priority/high
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
437

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.