docs: fix wording for Script and Plugin compatibility#13012
Open
andrewbytecoder wants to merge 2 commits intoapache:masterfrom
Open
docs: fix wording for Script and Plugin compatibility#13012andrewbytecoder wants to merge 2 commits intoapache:masterfrom
andrewbytecoder wants to merge 2 commits intoapache:masterfrom
Conversation
Signed-off-by: Abhishek Choudhary <shreemaan.abhishek@gmail.com>
This PR fixes a minor but potentially confusing typo in docs/en/latest/script.md (and its Chinese counterpart if applicable), where the terms "Script" and "Plugin" were incorrectly used interchangeably or mislabeled in a sentence describing APISIX's extension mechanisms. In Apache APISIX, Scripts and Plugins are distinct concepts: Plugins are reusable, configurable modules that hook into the request lifecycle (e.g., key-auth, limit-req). Scripts refer to inline Lua logic attached directly to a Route (or Service) for custom, route-specific behavior. The original wording blurred this distinction, which could mislead users about APISIX’s architecture. This PR corrects the terminology to ensure clarity and technical accuracy. Which issue(s) this PR fixes: Fixes # Checklist [x] I have explained the need for this PR and the problem it solves [x] I have explained the changes or the new features added to this PR [ ] I have added tests corresponding to this change >Not applicable: documentation-only change [x] I have updated the documentation to reflect this change [x] I have verified that this change is backward compatible ✅ Note: Since this is a documentation typo fix with no behavioral impact, no tests are required. The change improves clarity without altering functionality.
dosubot
bot
added
size:XS
dosubot
bot
added
size:M
Baoyuantop
changed the title
Contributor
|
Hi @andrewbytecoder, I've modified the upstream branch; please merge it into the main branch to reduce the differences. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes a minor but potentially confusing typo in docs/en/latest/script.md (and its Chinese counterpart if applicable), where the terms "Script" and "Plugin" were incorrectly used interchangeably or mislabeled in a sentence describing APISIX's extension mechanisms.
In Apache APISIX, Scripts and Plugins are distinct concepts:
Plugins are reusable, configurable modules that hook into the request lifecycle (e.g., key-auth, limit-req).
Scripts refer to inline Lua logic attached directly to a Route (or Service) for custom, route-specific behavior.
The original wording blurred this distinction, which could mislead users about APISIX’s architecture. This PR corrects the terminology to ensure clarity and technical accuracy.
Which issue(s) this PR fixes:
Fixes #
Checklist
[x] I have explained the need for this PR and the problem it solves
[x] I have explained the changes or the new features added to this PR
[ ] I have added tests corresponding to this change
✅ Note: Since this is a documentation typo fix with no behavioral impact, no tests are required. The change improves clarity without altering functionality.