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

buger commented 1 week 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.
Updated the menu structure to include links to the new documentation pages.
Corrected spelling and reference links in existing documentation.

Changes walkthrough 📝

Relevant files

Documentation

processing-pipelines.md `Correct 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
overview.md `Add overview documentation for Tyk Streams inputs.` tyk-docs/content/product-stack/tyk-streaming/configuration/inputs/overview.md Added an overview page for inputs in Tyk Streams. Explained the concept of inputs and brokering. Described the use of labels and message generation.	+64/-0
overview.md `Add overview documentation for Tyk Streams outputs.` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/overview.md Added an overview page for outputs in Tyk Streams. Explained back pressure, retries, and dead letter queues. Described multiplexing outputs and the use of labels.	+109/-0
reject.md `Document reject output configuration in Tyk Streams.` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/reject.md Introduced a page for the reject output in Tyk Streams. Explained the use of reject output for failed message routing.	+37/-0
switch.md `Add documentation for switch output configuration.` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/switch.md Added documentation for configuring switch outputs. Provided examples of basic and advanced multiplexing. Explained fields like retry_until_success and strict_mode.	+165/-0
for-each.md `Fix reference link in for-each processor documentation.` tyk-docs/content/product-stack/tyk-streaming/configuration/processors/for-each.md - Corrected the reference link for the dedupe processor.	+1/-1
overview.md `Add overview documentation for Tyk Streams processors.` tyk-docs/content/product-stack/tyk-streaming/configuration/processors/overview.md Added an overview page for processors in Tyk Streams. Explained processor configuration and error handling. Discussed using processors as outputs and handling batches.	+99/-0
menu.yaml `Update menu structure to include new documentation pages.` tyk-docs/data/menu.yaml Updated menu to include new overview pages for inputs, outputs, and processors. Added 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 week ago

PR Reviewer Guide 🔍

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Placeholder Content
The file contains placeholder content such as 'TODO' which should be replaced with actual content before merging. Placeholder Content
The file contains placeholder content such as 'TODO' which should be replaced with actual content before merging. Placeholder Content
The file contains placeholder content such as 'TODO' which should be replaced with actual content before merging.

github-actions[bot] commented 1 week ago

PR Code Suggestions ✨

No code suggestions found for the PR.

netlify[bot] commented 1 week ago

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

Name	Link
Latest commit	bed43212246f1a392dea7b7a6354ba0241fafe81
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66dee82777ef460008f5bb73
Deploy Preview	https://deploy-preview-5372--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 week ago

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

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