api: manifest based edge default documentation.#11151
Merged
htuch merged 3 commits intoenvoyproxy:masterfrom May 17, 2020
Merged
api: manifest based edge default documentation.#11151htuch merged 3 commits intoenvoyproxy:masterfrom
htuch merged 3 commits intoenvoyproxy:masterfrom
Conversation
htuch
commented
May 11, 2020
Member
Author
There was a problem hiding this comment.
The plan is to fill out these annotations and the manifest examples for the remaining default edge examples if we agree on this approach.
This PR replaces envoyproxy#11058, taking a slightly different approach. We utilize field options to annotate fields that should be set for untrusted environments with [configure_for_untrusted_downstream, configure_for_untrusted_downstream]. Defaults are provided out-of-band, in a manifest files in docs/edge_defaults_manifest.yaml. Protodoc glues the manifest and options together when generating field documentation, providing an additional notice for sensitive fields. This PR depends on envoyproxy#11108 first merging to provide the pip3 build infrastructure. Risk level: Low (docs only). Testing: Inspection of generated docs. Signed-off-by: Harvey Tuch <htuch@google.com>
Member
Author
|
This is now ready for general review, as the base #11108 has merged. |
mattklein123
requested changes
May 14, 2020
Member
mattklein123
left a comment
There was a problem hiding this comment.
This is SO SO SO amazing! 👏 👏 👏
Just some minor question/comments but suggest we ship and iterate. Thank you!
/wait
| @@ -0,0 +1,56 @@ | |||
| # Validate a YAML fragment against an Envoy API proto3 type. | |||
Member
There was a problem hiding this comment.
This is so, so, so close to the sphinx plugin. ;)
Member
Author
There was a problem hiding this comment.
Right, @dmitri-d is working on the Sphinx RST plugin side of this at the moment.
Signed-off-by: Harvey Tuch <htuch@google.com>
spenceral
added a commit
to spenceral/envoy
that referenced
this pull request
May 20, 2020
Signed-off-by: Spencer Lewis <slewis@squareup.com> * master: (33 commits) docs: break release notes into categories (envoyproxy#11217) admin: extract more handlers to separate classes (envoyproxy#11258) Load reporting service documentation (envoyproxy#10962) http: testing 304-with-body behavior (envoyproxy#11261) fixing typos and breaking link issues (envoyproxy#11270) devex: initial commit of devcontainer setup (envoyproxy#11207) security: update policy for fix/disclosure SLOs. (envoyproxy#11243) http: fixing CONNECT to not advertise chunk encoding. (envoyproxy#11245) docs: update upstream network filters description (envoyproxy#11231) deps: update datadog tracer to v1.1.5 (envoyproxy#11253) test: Fix missing instantiation of parameterized tests. (envoyproxy#11247) fix go mirror when no changes (envoyproxy#11249) docs: host_rewrite -> host_rewrite_literal (envoyproxy#11229) wasm: update V8 to v8.3.110.9. (envoyproxy#11233) tls: update BoringSSL to 107c03cf (4103). (envoyproxy#11232) bazelci: always exclude nocoverage tag in coverage config (envoyproxy#11226) ci: save api revision in go-control-plane (envoyproxy#11220) build: fix cares build (envoyproxy#11225) stats: Pre-allocate codec stats for http1 and http2 (envoyproxy#11135) api: manifest based edge default documentation. (envoyproxy#11151) ...
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.
This PR replaces #11058, taking a slightly different approach. We utilize field options to annotate fields that should be set for untrusted environments with [configure_for_untrusted_downstream, configure_for_untrusted_downstream]. Defaults are provided out-of-band, in a manifest files in docs/edge_defaults_manifest.yaml.
Protodoc glues the manifest and options together when generating field documentation, providing an additional notice for sensitive fields.
Risk level: Low (docs only).
Testing: Inspection of generated docs.
Signed-off-by: Harvey Tuch htuch@google.com