-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: update "Traffic" Plugin docs 2 #7050
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update "Traffic" Plugin docs 2 #7050
Conversation
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
|
// @hf400159 @kwanhur @avinal @yzeng25 @juzhiyuan Please review when you are available. |
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
juzhiyuan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Others LGTM
guitu168
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
other LGTM.
| ```shell | ||
| $ curl -i -X POST "http://127.0.0.1:9080/hello" | ||
| curl -i -X POST "http://127.0.0.1:9080/hello" | ||
| HTTP/1.1 502 Bad Gateway |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The request and response should use two code blocks.
| Response 500 or 503 three times in a row to trigger a unhealthy. Response 200 once in a row to restore healthy. | ||
| The example below shows how you can configure the Plugin on a specific Route: | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be bash。please refer to #7030 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing is that shell also seems to work. It is what was used in the docs in the past and it was what I used in the previous PRs except for the last PR. I also did not see any support for it but it seems to work and we seem to be using it everywhere.
@juzhiyuan @hf400159 @avinal What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the style guide doesn't mention which one should use, then both work for me :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with what you said
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either bash or shell is fine (though they have different meanings), when it comes to referring them in code block as bash and shell, they have the same behaviors.
I think you should consider specifying them in guidelines as well.
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
|
Made the changes as suggested. |
juzhiyuan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat navendupottekkat@gmail.com
Description
Updates the documentation of the "proxy-cache", "request-validatoin", "proxy-mirror", and "api-breaker" Plugins.
Child PR of #6734