envoyproxy/envoy

Add a sphinx plugin to allow linking from demo configurations to api sections

Open

#15.332 aberto em 5 de mar. de 2021

Ver no GitHub
 (6 comments) (0 reactions) (1 assignee)C++ (5.373 forks)batch import
area/docshelp 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

learning envoy configuration can be quite a steep learning curve and its not always easy to navigate the docs to find the relevant spec

im thinking it might be helpful if the config examples in the docs provided a click through to the relevant api section - perhaps if you hover over the line a link appears at the end, for example

depending on how fine grained the links were, i think we might need to add more ref links in the api to allow that

on a related point im noticing that all most of the api examples are json - whereas the config examples are mostly yaml. There are probably good reasons for both, but im thinking this is another way in which the docs can jar for new users.

Guia do colaborador

Direção de pesquisa
Examine a configuração Sphinx existente e a estrutura da documentação da API para entender como as referências são definidas, depois projete um plugin que adicione links flutuantes dos exemplos de configuração YAML/JSON para as seções relevantes da API.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
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.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65