docs: first pass at documenting how to add extensions#11540
Merged
Conversation
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
htuch
suggested changes
Jun 10, 2020
Member
htuch
left a comment
htuch
left a comment
There was a problem hiding this comment.
Thanks for adding this! A few nits/suggestions.
/wait
|
|
||
| # Adding new extensions | ||
|
|
||
| For developers adding a new extension, one can largely model off of existing extensions. |
Member
There was a problem hiding this comment.
Suggested change
| For developers adding a new extension, one can largely model off of existing extensions. | |
| For developers adding a new extension, one can take an existing extension as the starting point. |
| `source/extensions/area/plugin`, and include an envoy_cc_extension with the | ||
| configuration and tagged with the appropriate security posture, and an | ||
| envoy_cc_library with the code. | ||
|
|
Member
There was a problem hiding this comment.
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
lizan
reviewed
Jun 11, 2020
| For developers adding a new extension, one can take an existing extension as the starting point. | ||
|
|
||
| Extension configuration should be located in a directory structure like | ||
| `api/envoy/extensions/area/plugin/`, for example `api/envoy/extensions/tracers/zipkin/` |
Member
There was a problem hiding this comment.
Let's use other extension as examples other than tracers, they only have v4alpha which might be confusing.
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Contributor
Author
|
@htuch I miss anything or is this good to go? |
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Contributor
Author
|
Nit should be addressed! |
songhu
pushed a commit
to songhu/envoy
that referenced
this pull request
Jun 25, 2020
This includes enhancing the script failures to leave breadcrumbs for devs who miss the new docs. Risk Level: n/a (tooling / docs) Testing: manual testing removing files from envoyproxy#11327 Docs Changes: yes Release Notes: no Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
yashwant121
pushed a commit
to yashwant121/envoy
that referenced
this pull request
Jul 24, 2020
This includes enhancing the script failures to leave breadcrumbs for devs who miss the new docs. Risk Level: n/a (tooling / docs) Testing: manual testing removing files from envoyproxy#11327 Docs Changes: yes Release Notes: no Signed-off-by: Alyssa Wilk <alyssar@chromium.org> Signed-off-by: yashwant121 <yadavyashwant36@gmail.com>
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
3 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 includes enhancing the script failures to leave breadcrumbs for devs who miss the new docs.
Risk Level: n/a (tooling / docs)
Testing: manual testing removing files from #11327
Docs Changes: yes
Release Notes: no