envoyproxy / envoyproxy/envoy

literalincludes in docs can be broken by changes to yaml files

Open
#15,973 1 comment 0 reactions 0 assignees View on GitHub
area/configuration area/docs no stalebot
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
428

Description

### description

there are a few cases in the docs where `yaml` files are `literalincluded`

if they don't include all lines, or if some lines are emphasized this can break when the yaml files change

this is kinda brittle - but theres not an easy way to prevent - although we may be able to add some indexing of relevent files/lines and expected content which could potentially trigger a fail in ci when the expectations are no longer met

in the meantime, its important when reviewing config files that are included in this way to check if the change impacts the docs

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.