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 info about plugin execution order and phases #9999

Merged
merged 9 commits into from
Oct 9, 2023

Conversation

shreemaan-abhishek
Copy link
Contributor

@shreemaan-abhishek shreemaan-abhishek commented Aug 9, 2023

Description

With the current situation of documentation, it's very likely that users might end up not having any context about Global rules when considering the plugin execution precedence.

Update info about plugin execution order and phases.

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@monkeyDluffy6017
Copy link
Contributor

Please make the ci pass

@monkeyDluffy6017 monkeyDluffy6017 added the wait for update wait for the author's response in this issue/PR label Aug 16, 2023
@monkeyDluffy6017 monkeyDluffy6017 added discuss and removed wait for update wait for the author's response in this issue/PR labels Aug 22, 2023
@monkeyDluffy6017
Copy link
Contributor

@kayx23 please help to check this

docs/en/latest/tutorials/protect-api.md Outdated Show resolved Hide resolved
docs/en/latest/terminology/plugin-config.md Outdated Show resolved Hide resolved
Co-authored-by: Traky Deng <trakydeng@gmail.com>
@monkeyDluffy6017 monkeyDluffy6017 added wait for update wait for the author's response in this issue/PR and removed discuss labels Sep 1, 2023
@kayx23
Copy link
Member

kayx23 commented Sep 1, 2023

@monkeyDluffy6017 I've reviewed this and my comment is as follows: #10031 (comment)

Notably, I don't think the global plugin running ONLY on before_proxy() is something that should be handled by the doc. If it indeed is, this PR can be merged as-is as I have no other recommendations to make it more clear.

Let's continue this convo in the issue above.

@shreemaan-abhishek
Copy link
Contributor Author

@monkeyDluffy6017, should we support plugins that run in other phases except before_proxy to be applied as global rules?

@monkeyDluffy6017
Copy link
Contributor

@shreemaan-abhishek I will close this pr since we are going to support global rules run in other phases

@kayx23
Copy link
Member

kayx23 commented Sep 27, 2023

This PR has other helpful doc changes other than the global plugin running ONLY on before_proxy(), so I'm reopening.

@kayx23 kayx23 reopened this Sep 27, 2023
shreemaan-abhishek and others added 2 commits October 8, 2023 20:02
Co-authored-by: Traky Deng <trakydeng@gmail.com>
@kayx23 kayx23 removed the wait for update wait for the author's response in this issue/PR label Oct 9, 2023
@kayx23 kayx23 changed the title docs: add info about global rules docs: update info about plugin execution order and phases Oct 9, 2023
@monkeyDluffy6017 monkeyDluffy6017 merged commit 455a680 into apache:master Oct 9, 2023
8 checks passed
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