User description
For internal users - Please add a Jira DX PR ticket to the subject!
DX-815
Note: PR has 5 content files, the remaining files are images.
Preview Link
preview
Description
- Improve Plugins Overview Page
- Add Plugins API configuration section
Note: awaiting image for plugin bundles overview
Screenshots (if appropriate)
Checklist
- [x] I have added a preview link to the PR description.
- [x] I have reviewed the guidelines for contributing to this repository.
- [x] I have read the technical guidelines for contributing to this repository.
- [x] Make sure you have started your change off our latest
master
.
- [x] I labelled the PR
PR Type
Documentation, Enhancement
Description
- Comprehensive update to the Plugins Overview page, including new sections for supported languages, plugin types, and configuration.
- Added detailed documentation for configuring API plugins using source files and bundles for both Tyk Classic and Tyk OAS APIs.
- Included configuration steps and screenshots for setting up plugins via Tyk Dashboard.
- Reorganized the menu structure to include links to the new documentation pages.
Changes walkthrough 📝
| Relevant files |
---|
Documentation |
plugins.mdComprehensive update to the Plugins Overview page.
tyk-docs/content/plugins.md
Updated the overview and introduction to plugins. Added sections for supported languages, how plugins work, plugin types, and plugin configuration. Included a high-level architectural diagram and detailed configuration examples. Added a "What's Next?" section with links to tutorials and resources.
|
+105/-21 |
source-bundles.mdAdded documentation for configuring API plugins using bundles.
tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/open-source/source-bundles.md
Added new documentation for configuring API plugins using bundles for Tyk Classic and Tyk OAS APIs. Included configuration examples and explanations for both API types.
|
+75/-0 |
source-files.mdAdded documentation for configuring API plugins using source files.
tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/open-source/source-files.md
Added new documentation for configuring API plugins using source files for Tyk Classic and Tyk OAS APIs. Included detailed configuration examples and explanations for both API types.
|
+173/-0 |
source-bundles.mdAdded documentation for configuring API plugins using bundles via Tyk
Dashboard.
tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/self-managed/source-bundles.md
Added new documentation for configuring API plugins using bundles via Tyk Dashboard. Included configuration steps and screenshots for both Tyk Classic and Tyk OAS APIs.
|
+32/-0 |
source-files.mdAdded documentation for configuring API plugins using source files via
Tyk Dashboard.
tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/self-managed/source-files.md
Added new documentation for configuring API plugins using source files via Tyk Dashboard. Included configuration steps and screenshots for both Tyk Classic and Tyk OAS APIs.
|
+48/-0 |
|
Configuration changes |
menu.yamlUpdated menu structure to include new plugin configuration
documentation.
tyk-docs/data/menu.yaml
Reorganized the menu structure to include new sections for API configuration. Added links to new documentation pages for configuring plugins using source files and bundles.
|
+44/-16 |
|
💡 PR-Agent usage:
Comment /help
on the PR to get a list of all available PR-Agent tools and their descriptions