envoyproxy/envoy

docs: verify config snippets are valid

Open

#8,837 创建于 2019年10月31日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)C++ (5,373 fork)batch import
area/docshelp wantedpriority/high

仓库指标

Star
 (27,997 star)
PR 合并指标
 (平均合并 8天) (30 天内合并 378 个 PR)

描述

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++.

贡献者指南