envoyproxy/envoy

In docs, make use of version_added, version_changed, deprecated etc sphinx directives

Open

#15.763 aberto em 30 de mar. de 2021

Ver no GitHub
 (11 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/docsarea/protobufenhancementhelp wanted

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

description

if we included in the documentation the version information - ie when added, changed, deprecated or removed it would be very helpful for users.

it would also might make it clearer why problems coming from version/configuration mis/matches do/not work

i think we can get most of this information from protos - not sure immediately how we show removed - but that would be v helpful when upgrading

Guia do colaborador

Direção de pesquisa
Familiarize se com a estrutura de documentação do projeto e o Sphinx. Veja os arquivos proto para identificar os campos version added, version changed, deprecated e removed. Em seguida, adicione as diretivas apropriadas aos arquivos de documentação.
Pilha de tecnologia
cpp
Domain
documentation
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
SphinxGitprotobuf
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75