Skip to content

docs: update API STYLE.md#21469

Merged
phlax merged 4 commits intoenvoyproxy:mainfrom
daixiang0:style
Jun 6, 2022
Merged

docs: update API STYLE.md#21469
phlax merged 4 commits intoenvoyproxy:mainfrom
daixiang0:style

Conversation

@daixiang0
Copy link
Copy Markdown
Member

@daixiang0 daixiang0 commented May 27, 2022

Signed-off-by: Loong Dai loong.dai@intel.com

Commit Message: Add some examples and adjust the development flow to make it clear.
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

Signed-off-by: Loong Dai <loong.dai@intel.com>
@repokitteh-read-only
Copy link
Copy Markdown

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/21469/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: #21469 was opened by daixiang0.

see: more, trace.

Signed-off-by: Loong Dai <loong.dai@intel.com>
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.

@daixiang0 this looks good - thanks for this

my suggestion would be not to add the "...otherwise this will happen lines" re proto_format.sh as i think it makes the points less clear

rather i have suggested editing the proto_format.sh line itself with a bit more information about potentially messing your filesystem

Signed-off-by: Loong Dai <loong.dai@intel.com>
@daixiang0
Copy link
Copy Markdown
Member Author

@phlax thanks for your review, I have updated all.

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.

@daixiang0 one small nit and i think should be good to land

Signed-off-by: Loong Dai <loong.dai@intel.com>
@daixiang0
Copy link
Copy Markdown
Member Author

@phlax please review again.

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 @daixiang0

@phlax phlax merged commit e1ede96 into envoyproxy:main Jun 6, 2022
@daixiang0 daixiang0 deleted the style branch June 7, 2022 00:35
tyxia pushed a commit to tyxia/envoy that referenced this pull request Jun 14, 2022
Signed-off-by: Loong Dai <loong.dai@intel.com>
Signed-off-by: Tianyu Xia <tyxia@google.com>
Amila-Rukshan pushed a commit to Amila-Rukshan/envoy that referenced this pull request Jun 28, 2022
Signed-off-by: Loong Dai <loong.dai@intel.com>
Signed-off-by: Amila Senadheera <amila.15@cse.mrt.ac.lk>
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