Merging to release-5.5: [DX 815] Improve Plugins Overview (#4918)

buger commented 2 months ago

User description

[DX 815] Improve Plugins Overview (#4918)

Thanks @andyo-tyk for review. I have committed review suggestions and will publish

Co-authored-by: Simon Pears simon@tyk.io Co-authored-by: andyo-tyk 99968932+andyo-tyk@users.noreply.github.com

PR Type

Documentation

Description

Comprehensive update to the plugin documentation, focusing on developing and configuring plugins for Tyk APIs.
Added detailed guides for configuring plugins in both Tyk Classic and Tyk OAS APIs.
Introduced new sections on plugin bundles, including creation and configuration using the CLI tool.
Updated the menu structure to reflect changes in the documentation, improving navigation and accessibility.

Changes walkthrough 📝

Relevant files

Documentation

8 files

plugins.md `Comprehensive update on plugin development and configuration` tyk-docs/content/plugins.md Updated the title and description to focus on developing plugins. Expanded explanation of plugin lifecycle and types. Added sections on supported languages and plugin deployment. Included detailed configuration instructions for Tyk Gateway.	+103/-24
plugin-bundles.md `Detailed guide on using and configuring plugin bundles` tyk-docs/content/plugins/how-to-serve-plugins/plugin-bundles.md Explained the concept and use of plugin bundles. Detailed the process of caching and configuring plugin bundles. Provided instructions for creating plugin bundles using the CLI tool.	+48/-118
classic.md `Guide for configuring plugins in Tyk Classic APIs` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/classic.md Added documentation for configuring plugins in Tyk Classic APIs. Included examples of plugin configuration in API definitions. Explained the use of the API Designer for plugin configuration.	+125/-0
oas.md `Guide for configuring plugins in Tyk OAS APIs` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/oas.md Added documentation for configuring plugins in Tyk OAS APIs. Provided examples of plugin configuration in OAS API definitions. Explained the use of the API Designer for plugin configuration.	+159/-0
overview.md `Overview of API plugin configuration` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/api-config/overview.md Introduced an overview of plugin configuration for APIs. Explained different plugin locations and configuration options. Provided guidance on language configuration for plugins.	+49/-0
bundle-cli.md `Documentation for Bundler CLI tool usage` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/bundles/bundle-cli.md Documented the usage of the Bundler CLI tool. Provided instructions for creating plugin bundles. Listed options for the CLI tool.	+43/-0
classic.md `Configuring plugin bundles for Tyk Classic APIs` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/bundles/classic.md Explained how to configure Tyk Classic APIs to use plugin bundles. Provided examples of API definition configuration. Detailed steps for using the API Designer.	+77/-0
oas.md `Configuring plugin bundles for Tyk OAS APIs` tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/plugins/bundles/oas.md Explained how to configure Tyk OAS APIs to use plugin bundles. Provided examples of API definition configuration. Detailed steps for using the API Designer.	+102/-0

Configuration changes

1 files

menu.yaml

Update menu structure for plugin documentation

tyk-docs/data/menu.yaml

Updated menu structure to reflect new plugin documentation.

Added entries for plugin configuration and bundles.

Reorganized plugin-related menu items.

+43/-15

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions[bot] commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Documentation Clarity
The new documentation added in 'plugins.md' is comprehensive but may benefit from additional examples and clearer separation of sections to enhance readability and understanding, especially for new users. Configuration Details
The section on configuring Tyk Gateway to load plugin bundles could be expanded to include more detailed examples of the configuration files and their settings, particularly around security settings for bundle verification. API Configuration Example
The example JSON configuration provided might be too complex for beginners. Consider breaking it down or providing a simpler initial example followed by this more detailed one.

github-actions[bot] commented 2 months ago

PR Code Suggestions ✨

No code suggestions found for the PR.

netlify[bot] commented 2 months ago

PS. Pls add /docs/nightly to the end of url

Name	Link
Latest commit	b39e80d4b468d1cb37c84f660da30f256e7efc19
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66db2c5a60114e0008ae8b2a
Deploy Preview	https://deploy-preview-5361--tyk-docs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 2 months ago

PS. Pls add /docs/nightly to the end of url

Name	Link
Latest commit	b39e80d4b468d1cb37c84f660da30f256e7efc19
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66db2c5a60114e0008ae8b2a
Deploy Preview	https://deploy-preview-5361--tyk-docs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

TykTechnologies / tyk-docs