Skip to content

protos/docs: Cleanups for extensions/categories#15098

Merged
htuch merged 1 commit intoenvoyproxy:mainfrom
phlax:docs-extensions-cleanup
Feb 26, 2021
Merged

protos/docs: Cleanups for extensions/categories#15098
htuch merged 1 commit intoenvoyproxy:mainfrom
phlax:docs-extensions-cleanup

Conversation

@phlax
Copy link
Copy Markdown
Member

@phlax phlax commented Feb 18, 2021

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: protos/docs: Cleanups for extensions/categories
Additional Description:

Some of the categories etc added in #14721 were not exactly correct and/or consistent

Also there is now some duplication from where links/info have been added manually previously

This PR should address these issues

Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue] Ref #13167
[Optional Deprecated:]
[Optional API Considerations:]

@repokitteh-read-only
Copy link
Copy Markdown

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/envoy/.
API shepherd assignee is @htuch
CC @envoyproxy/api-watchers: FYI only for changes made to api/envoy/.

🐱

Caused by: #15098 was opened by phlax.

see: more, trace.

@phlax phlax marked this pull request as draft February 18, 2021 12:34
@phlax phlax changed the title protos/docs: Cleanups for extensions/categories [WIP] protos/docs: Cleanups for extensions/categories Feb 18, 2021
@htuch
Copy link
Copy Markdown
Member

htuch commented Feb 18, 2021

Thanks, I kind of expected there to be some followup. LMK when this is ready for review.

@phlax phlax force-pushed the docs-extensions-cleanup branch 4 times, most recently from 1dfbfdc to 88f0efc Compare February 25, 2021 11:36
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the docs-extensions-cleanup branch from 88f0efc to 9c34d36 Compare February 25, 2021 11:48
@phlax phlax marked this pull request as ready for review February 25, 2021 12:45
@phlax phlax changed the title [WIP] protos/docs: Cleanups for extensions/categories protos/docs: Cleanups for extensions/categories Feb 25, 2021
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Feb 25, 2021

@htuch theres probably some more of these - but it would be good to land these ones

as i work through the schema generated in #15100 ill hopefully find remaining issues

// See the supported filters for further documentation.
// [#extension-category: envoy.filters.listener]
oneof config_type {
// Filter specific configuration which depends on the filter being
Copy link
Copy Markdown
Member Author

@phlax phlax Feb 25, 2021

Choose a reason for hiding this comment

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

in this case it was necessary to move the comment (as well as the annotation) inside the oneof (as is done with others)

not doing so threw a formatting error - so we might need to look at the \n mangling in protodoc to make it less brittle

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Feb 25, 2021

Also there is now some duplication from where links/info have been added manually previously

i have created a ticket for this as it will take some more time going through and thinking how best to update - #15191

Copy link
Copy Markdown
Member

@htuch htuch 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!

@htuch htuch merged commit f9301ff into envoyproxy:main Feb 26, 2021
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.

2 participants