envoyproxy/envoy

docs: verify config snippets are valid

Open

#8.837 aberto em 31 de out. de 2019

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)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

This is an aspirational work item, but it would be really nice if we could verify all of the config snippets in the docs are actually valid config. The way I would imagine this working is:

  1. Develop a new Sphinx plugin for an Envoy config snippet. This would identify the associated proto that it should load into.
  2. During doc generation, go through all snippets, and try to load the config YAML into the actual proto.

This would catch stale config. This might be a good GSoC project or a good item for someone that wants to do something really useful that is not C++.

Guia do colaborador

Direção de pesquisa
Investigue o sistema de build da documentação do Envoy, aprenda como funcionam as extensões Sphinx e explore como carregar definições protobuf para validar snippets de configuração YAML.
Pilha de tecnologia
cpppython
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
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
GitPythonSphinxprotobuf
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65