Skip to content

reference glitch in docs for Network filter chain processing#17087

Closed
ankatare wants to merge 1 commit intoenvoyproxy:mainfrom
ankatare:reference_glitch_filters
Closed

reference glitch in docs for Network filter chain processing#17087
ankatare wants to merge 1 commit intoenvoyproxy:mainfrom
ankatare:reference_glitch_filters

Conversation

@ankatare
Copy link
Copy Markdown
Contributor

Signed-off-by: Abhay Narayan Katare abhay.katare@india.nec.com

Commit Message: ref glitch in docs for Network filter chain processings
Additional Description: in https://www.envoyproxy.io/docs/envoy/latest/intro/life_of_a_request#network-filter-chain-processing
for readFilter/writeFilter and Filter there is ref issues.
Risk Level: LOW
Testing: Yes
Docs Changes: Yes
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]
[Optional API Considerations:]

Signed-off-by: Abhay Narayan Katare <abhay.katare@india.nec.com>
@ankatare ankatare changed the title reference glitches in docs for Network filter chain processing reference glitch in docs for Network filter chain processing Jun 22, 2021
Copy link
Copy Markdown
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm - thanks @ankatare

im wondering if there are any more of this issue ?

@phlax
Copy link
Copy Markdown
Member

phlax commented Jun 22, 2021

doing

$ git grep "<include/envoy" docs/

suggests yes - do you want to fix the other references at the same time ?

@ankatare
Copy link
Copy Markdown
Contributor Author

@phlax Thanks. currently yes, i can help . please suggest how to proceed.

@ankatare
Copy link
Copy Markdown
Contributor Author

ankatare commented Jun 22, 2021

@phlax found these many... will push changes soon

necuser@dldt-project_005:~/new_folder/envoy$  git grep "<include/envoy" docs/
docs/root/configuration/advanced/well_known_dynamic_metadata.rst::repo:`StreamInfo <include/envoy/stream_info/stream_info.h>` interface on a
docs/root/configuration/advanced/well_known_dynamic_metadata.rst::repo:`Connection <include/envoy/network/connection.h>`. This metadata emitted by a filter can be
docs/root/configuration/http/http_filters/lua_filter.rst:Returns :repo:`information <include/envoy/stream_info/stream_info.h>` related to the current request.
docs/root/configuration/http/http_filters/lua_filter.rst:Returns the current request's underlying :repo:`connection <include/envoy/network/connection.h>`.
docs/root/configuration/http/http_filters/lua_filter.rst:Returns the string representation of :repo:`HTTP protocol <include/envoy/http/protocol.h>`
docs/root/configuration/http/http_filters/lua_filter.rst:Returns the string representation of :repo:`downstream remote address <include/envoy/stream_info/stream_info.h>`
docs/root/configuration/http/http_filters/lua_filter.rst:Returns the string representation of :repo:`downstream directly connected address <include/envoy/stream_info/stream_info.h>`
docs/root/configuration/http/http_filters/lua_filter.rst:Returns :repo:`information <include/envoy/ssl/connection.h>` related to the current SSL connection.
docs/root/configuration/http/http_filters/lua_filter.rst:Returns the string representation of :repo:`requested server name <include/envoy/stream_info/stream_info.h>`
docs/root/configuration/http/http_filters/lua_filter.rst:Returns :repo:`SSL connection <include/envoy/ssl/connection.h>` object when the connection is
docs/root/configuration/observability/access_log/usage.rst:    can be set by filters using the :repo:`StreamInfo <include/envoy/stream_info/stream_info.h>` API:
docs/root/intro/life_of_a_request.rst:The TLS inspector filter implements the :repo:`ListenerFilter <include/envoy/network/filter.h>`
docs/root/intro/life_of_a_request.rst::repo:`TransportSocket <include/envoy/network/transport_socket.h>`
docs/root/intro/life_of_a_request.rst:* :repo:`StreamDecoderFilter <include/envoy/http/filter.h>` with callbacks for request processing.
docs/root/intro/life_of_a_request.rst:* :repo:`StreamEncoderFilter <include/envoy/http/filter.h>` with callbacks for response processing.
docs/root/intro/life_of_a_request.rst:* :repo:`StreamFilter <include/envoy/http/filter.h>` implementing both ``StreamDecoderFilter`` and

@alyssawilk alyssawilk self-assigned this Jun 22, 2021
ankatare added a commit to ankatare/envoy that referenced this pull request Jun 23, 2021
Signed-off-by: Abhay Narayan Katare <abhay.katare@india.nec.com>
@ankatare
Copy link
Copy Markdown
Contributor Author

@phlax created #17098 . please review.

@phlax
Copy link
Copy Markdown
Member

phlax commented Jun 23, 2021

closing this as it has been covered in #17098

@phlax phlax closed this Jun 23, 2021
@ankatare ankatare deleted the reference_glitch_filters branch September 29, 2021 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants