envoyproxy/envoy

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

Open

#13.167 aberto em 18 de set. de 2020

Ver no GitHub
 (7 comments) (2 reactions) (1 assignee)C++ (5.373 forks)batch import
area/docshelp wantedpriority/high

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue os pontos de extensão tipados existentes no código do Envoy, entenda o sistema de build Bazel para extrair metadados de extensão e crie um script que despeje todos os tipos internos e gere documentação automaticamente.
Pilha de tecnologia
cpp
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
C++Bazel
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60