docs: Move envoy config snippets to include files#13231
Merged
mattklein123 merged 3 commits intoenvoyproxy:masterfrom Sep 25, 2020
Merged
docs: Move envoy config snippets to include files#13231mattklein123 merged 3 commits intoenvoyproxy:masterfrom
mattklein123 merged 3 commits intoenvoyproxy:masterfrom
Conversation
Member
Author
|
@mattklein123 as this means moving quite a bit of config - i just did the first one i found for testing - if you are happy with this general direction - ill move the rest/more |
Member
|
Yeah this is totally fine with me. Whatever you think is best to getting to a path where everything is validated and won't bit rot. (See also the inline validation code that already exists that I mentioned elsewhere.) Let me know when this is ready to review. /wait |
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
4e1e80c to
a9a5d37
Compare
Signed-off-by: Ryan Northey <ryan@synca.io>
Member
Author
|
@mattklein123 i have updated the scope (see description) and deWIPped this |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Ryan Northey ryan@synca.io
Commit Message: docs: Move snippets to include files
Additional Description:
this moves any (lintable) snippets currently embedded in docs rst files into include files.
this will:
Risk Level: low
Testing: potentially
Docs Changes: yep
Release Notes:
[Optional Runtime guard:]
[Optional Fixes #Issue] touch #8837
[Optional Deprecated:]
update to scope
after looking through the docs - i realised that there are quite a lot of partial snippets. I have avoided these and just moved out the (full) envoy yaml snippets.
i think we might want to move the partial snippets after (and perhaps some non-yaml ones)
there are some funky things we can do with partial snippets - like add context and highlight certain lines, or sequentially show parts of an included full config, but all of these things are a bit more complex - so getting lintable/testable envoy configs out seems a greater priority.
also, im seeing that there is a
validated-code-blockextension - so i need to look at that more.