tyk-docs icon indicating copy to clipboard operation
tyk-docs copied to clipboard

[DX-1407] Tyk Streams: Add batching and dependencies

Open dcs3spp opened this issue 7 months ago • 8 comments

User description

For internal users - Please add a Jira DX PR ticket to the subject!

DX-1407


Preview Link

Description

Added batching processor and the following linked 8 dependencies for review:

Updated existing content with links to batching and missing links.

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


Description

  • Added new documentation for batching configuration, including examples and detailed descriptions.
  • Added new documentation for windowed processing, with examples and detailed descriptions of creating windows and aggregating data.
  • Added new documentation for input and output brokers, including examples and detailed descriptions of combining multiple inputs and brokering patterns.
  • Added new documentation for the drop_on output, explaining how to drop messages based on conditions.
  • Added new documentation for various processors, including group_by, group_by_value, select_parts, switch, and while, with examples and detailed descriptions.
  • Updated the menu to include links to the new documentation pages.

Changes walkthrough 📝

Relevant files
Documentation
10 files
batching.md
Add batching configuration documentation                                 

tyk-docs/content/product-stack/tyk-streaming/configuration/common-configuration/batching.md

  • Added a new document explaining batching configuration settings.
  • Included examples and detailed descriptions of batching policies.
  • Linked to related processing functions and components.
  • +196/-0 
    windowed_processing.md
    Add windowed processing documentation                                       

    tyk-docs/content/product-stack/tyk-streaming/configuration/common-configuration/windowed_processing.md

  • Added a new document explaining windowed processing.
  • Provided examples and detailed descriptions of creating windows and
    aggregating data.
  • +95/-0   
    broker.md
    Add input broker configuration documentation                         

    tyk-docs/content/product-stack/tyk-streaming/configuration/inputs/broker.md

  • Added a new document explaining the input broker configuration.
  • Included examples and detailed descriptions of combining multiple
    inputs.
  • +192/-0 
    broker.md
    Add output broker configuration documentation                       

    tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/broker.md

  • Added a new document explaining the output broker configuration.
  • Included examples and detailed descriptions of brokering patterns.
  • +217/-0 
    drop_on.md
    Add drop_on output configuration documentation                     

    tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/drop_on.md

  • Added a new document explaining the drop_on output configuration.
  • Provided examples and detailed descriptions of dropping messages based
    on conditions.
  • +104/-0 
    group-by-value.md
    Add group_by_value processor documentation                             

    tyk-docs/content/product-stack/tyk-streaming/configuration/processors/group-by-value.md

  • Added a new document explaining the group_by_value processor.
  • Included examples and detailed descriptions of grouping messages by
    value.
  • +55/-0   
    group-by.md
    Add group_by processor documentation                                         

    tyk-docs/content/product-stack/tyk-streaming/configuration/processors/group-by.md

  • Added a new document explaining the group_by processor.
  • Included examples and detailed descriptions of grouping messages by
    conditions.
  • +76/-0   
    select-pparts.md
    Add select_parts processor documentation                                 

    tyk-docs/content/product-stack/tyk-streaming/configuration/processors/select-pparts.md

  • Added a new document explaining the select_parts processor.
  • Included examples and detailed descriptions of selecting specific
    message parts.
  • switch.md
    Add switch processor documentation                                             

    tyk-docs/content/product-stack/tyk-streaming/configuration/processors/switch.md

  • Added a new document explaining the switch processor.
  • Provided examples and detailed descriptions of conditional message
    processing.
  • +78/-0   
    while.md
    Add while processor documentation                                               

    tyk-docs/content/product-stack/tyk-streaming/configuration/processors/while.md

  • Added a new document explaining the while processor.
  • Included examples and detailed descriptions of looping message
    processing.
  • +79/-0   
    Configuration changes
    1 files
    menu.yaml
    Update menu with new documentation links                                 

    tyk-docs/data/menu.yaml

  • Updated the menu to include new documentation pages for batching,
    windowed processing, brokers, and various processors.
  • +40/-0   

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

    dcs3spp avatar Jul 05 '24 15:07 dcs3spp