Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

literalincludes in docs can be broken by changes to yaml files #15973

Open
phlax opened this issue Apr 14, 2021 · 1 comment
Open

literalincludes in docs can be broken by changes to yaml files #15973

phlax opened this issue Apr 14, 2021 · 1 comment
Labels
area/configuration area/docs no stalebot Disables stalebot from closing an issue

Comments

@phlax
Copy link
Member

phlax commented Apr 14, 2021

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

@phlax phlax added triage Issue requires triage area/configuration area/docs and removed triage Issue requires triage labels Apr 14, 2021
@github-actions
Copy link

This issue has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in the next 7 days unless it is tagged "help wanted" or "no stalebot" or other activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale stalebot believes this issue/PR has not been touched recently label May 14, 2021
@phlax phlax added no stalebot Disables stalebot from closing an issue and removed stale stalebot believes this issue/PR has not been touched recently labels May 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/configuration area/docs no stalebot Disables stalebot from closing an issue
Projects
None yet
Development

No branches or pull requests

1 participant