Skip to content
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 "cors" docs #6877

Merged
merged 2 commits into from
Apr 22, 2022

Conversation

pottekkat
Copy link
Contributor

Signed-off-by: Navendu Pottekkat navendupottekkat@gmail.com

Description

Updates the documentation of the "cors" Plugin.

Child PR of #6734

Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Copy link
Member

@spacewander spacewander left a comment

Choose a reason for hiding this comment

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

Is it necessary to submit a PR per plugin, while the changes are similar?

@juzhiyuan
Copy link
Member

Is it necessary to submit a PR per plugin, while the changes are similar?

Hi, @spacewander,

I just checked all PRs, and each PR has minor changes, which means we could review and merge quickly.

Just to make sure, you would prefer the previous PR style? like PR[1]?

image

[1] #6824

@pottekkat
Copy link
Contributor Author

Is it necessary to submit a PR per plugin, while the changes are similar?

I will combine multiple PRs into one (one PR a day) from the next PRs. This would be a good middle ground.


Create a `Route` or `Service` object and configure `cors` plugin.
You can enable the Plugin on a specific Route or Service:

```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Copy link
Contributor

Choose a reason for hiding this comment

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

For commands that are too long, should we format them? or keep it?
I think formatting long commands helps the user to see all the commands, otherwise he also needs to slide the scroll bar. Maybe we need to do this in all documents.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I have kept it as it is on all docs. Maybe we can create a separate issue to ensure better formatting.

@spacewander spacewander merged commit 612b2a6 into apache:master Apr 22, 2022
@pottekkat pottekkat deleted the docs/plugin-security-cors/6734 branch April 22, 2022 11:49
Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request May 20, 2022
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
spacewander pushed a commit that referenced this pull request Jun 30, 2022
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
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.

4 participants