docs(gateway): explain dynamic plugin ordering and the plugin_ordering_algorithm option#5936
Draft
findns94 wants to merge 7 commits into
Draft
docs(gateway): explain dynamic plugin ordering and the plugin_ordering_algorithm option#5936findns94 wants to merge 7 commits into
findns94 wants to merge 7 commits into
Conversation
…g_algorithm option
Add a standalone explainer for dynamic plugin ordering and document the new
`plugin_ordering_algorithm` option that selects which ordering algorithm runs.
* app/gateway/plugins/plugin-ordering.md (new): the principle behind dynamic
ordering ("at each step, run the highest-priority plugin whose `after`
requirements are already met"), a hand-worked step-by-step example so readers can
predict the exact order, a new-vs-legacy comparison (including the FTI-7177
displacement and the `before` != `after` asymmetry, with concrete sorted results),
the guarantees and non-guarantees, how request scope changes the result, and how
to adopt `new` on upgrade.
* app/_gateway_entities/plugin.md: trim the "Dynamic plugin ordering" reference
section to link to the new explainer, and note the `plugin_ordering_algorithm`
option under known limitations.
* app/_indices/gateway.yaml: add the new page to the "How Gateway Works" navigation.
FTI-7177
Signed-off-by: Walker Zhao <walker.zhao@konghq.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Gateway reference page explaining how dynamic plugin ordering is computed (including a worked example and a new vs legacy comparison) and wires it into the existing Plugin entity docs and Gateway index navigation.
Changes:
- Adds a standalone explainer page for dynamic plugin ordering behavior and upgrade guidance.
- Updates the Plugin entity reference to link out to the explainer and mentions
plugin_ordering_algorithm. - Adds the new page to the Gateway “How Gateway Works” index section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| app/gateway/plugins/plugin-ordering.md | New reference page describing the ordering rule/algorithm behavior, examples, and limitations. |
| app/_gateway_entities/plugin.md | Links to the new explainer from the Dynamic plugin ordering section and mentions algorithm selection. |
| app/_indices/gateway.yaml | Adds the new page to the Gateway documentation index/navigation. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
works_on: - on-prem - konnect Signed-off-by: Walker Zhao <walker.zhao@konghq.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
Description
Add a standalone explainer for dynamic plugin ordering and document the new
plugin_ordering_algorithmoption that selects which ordering algorithm runs.afterrequirements are already met"), a hand-worked step-by-step example so readers can predict the exact order, a new-vs-legacy comparison (including the FTI-7177 displacement and thebefore!=afterasymmetry, with concrete sorted results), the guarantees and non-guarantees, how request scope changes the result, and how to adoptnewon upgrade.plugin_ordering_algorithmoption under known limitations.Fixes FTI-7177
Preview Links
https://deploy-preview-5936--kongdeveloper.netlify.app/gateway/plugins/plugin-ordering/
https://deploy-preview-5936--kongdeveloper.netlify.app/gateway/entities/plugin/#dynamic-plugin-ordering
Checklist
descriptionentry in frontmatter.