Merging to release-5.4: [DX-1407] Tyk Streams: Add overview page to Inputs, Outputs & Processors (#5360)

buger commented 1 month ago

User description

DX-1407 Tyk Streams: Add overview page to Inputs, Outputs & Processors (#5360)

add overview pages for inputs, outputs & processors

Co-authored-by: Simon Pears simon@tyk.io

PR Type

Documentation

Description

Added new overview documentation pages for Tyk Streams inputs, outputs, and processors, providing detailed explanations and examples.
Introduced documentation for reject and switch outputs, explaining their configurations and use cases.
Updated menu configuration to include new documentation pages, ensuring they are accessible from the main menu.
Corrected spelling and fixed links in existing documentation to improve clarity and accuracy.

Changes walkthrough 📝

Relevant files

Documentation

overview.md `Added overview documentation for Tyk Streams inputs.` tyk-docs/content/product-stack/tyk-streaming/configuration/inputs/overview.md Added an overview page for Tyk Streams inputs. Explained the concept of inputs and brokering. Described the use of labels and generating messages.	+64/-0
overview.md `Added overview documentation for Tyk Streams outputs.` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/overview.md Added an overview page for Tyk Streams outputs. Explained output configurations, back pressure, and retries. Described dead letter queues and multiplexing outputs.	+109/-0
reject.md `Added documentation for reject output in Tyk Streams.` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/reject.md Introduced a new page explaining the reject output. Provided examples of rejecting failed messages.	+37/-0
switch.md `Added documentation for switch output configuration.` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/switch.md Added a new page for configuring switch outputs. Explained common and advanced configurations with examples.	+165/-0
overview.md `Added overview documentation for Tyk Streams processors.` tyk-docs/content/product-stack/tyk-streaming/configuration/processors/overview.md Added an overview page for Tyk Streams processors. Described processor functions, error handling, and usage as outputs.	+99/-0
for-each.md `Fixed link for dedupe processor documentation.` tyk-docs/content/product-stack/tyk-streaming/configuration/processors/for-each.md - Updated link for dedupe processor documentation.	+1/-1
processing-pipelines.md `Corrected spelling in processing pipelines documentation.` tyk-docs/content/product-stack/tyk-streaming/configuration/common-configuration/processing-pipelines.md - Corrected spelling from 'utilise' to 'utilize'.	+1/-1

Configuration changes

menu.yaml

Updated menu configuration for new documentation pages.

tyk-docs/data/menu.yaml

Added menu entries for new overview pages for inputs, outputs, and
processors.

Included entries for reject and switch outputs.

+20/-0

💡 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 1 month ago

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Typo in Documentation
The word 'utilise' is changed to 'utilize'. Ensure consistency in spelling, either American or British English should be used consistently across the documentation. Missing Information
The 'addresses' field in the Kafka configuration example is marked as 'TODO'. This needs to be completed or removed if it's intended to be filled by the user. Placeholder URLs
Placeholder URLs are used in the AWS SQS and Kafka configuration examples. These should be replaced with actual values or further instructions for the user on what needs to be provided. Incomplete Configuration
The 'addresses' field in the AMQP configuration example contains a placeholder 'TODO:6379'. This should be replaced with actual values or removed if intended for user completion.

github-actions[bot] commented 1 month ago

PR Code Suggestions ✨

No code suggestions found for the PR.

netlify[bot] commented 1 month ago

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

Name	Link
Latest commit	5e8caf28ce9112f0597fee663e6766d899aefb84
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66dee85e41f5c500087a31ae
Deploy Preview	https://deploy-preview-5373--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 1 month ago

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

Name	Link
Latest commit	5e8caf28ce9112f0597fee663e6766d899aefb84
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66dee85e41f5c500087a31ae
Deploy Preview	https://deploy-preview-5373--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