Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TT-13557]: Updated documentation on input and output #5723

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kofoworola
Copy link
Contributor

@kofoworola kofoworola commented Nov 15, 2024

User description

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



TT-13557

Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

PR Type

documentation


Description

  • Removed documentation for outdated connectors including MQTT, RabbitMQ, Solace, RedPanda, and AMQP from the Tyk Streams key concepts.
  • Updated example to reflect conversion of HTTP messages to HTTP webhooks.

Changes walkthrough 📝

Relevant files
Documentation
key-concepts.md
Update Tyk Streams documentation by removing outdated connectors

tyk-docs/content/product-stack/tyk-streaming/key-concepts.md

  • Removed documentation for several connectors: MQTT, RabbitMQ, Solace,
    RedPanda, and AMQP.
  • Updated example to convert HTTP messages to HTTP webhooks.
  • +1/-7     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Content Removal
    Significant content removal without clear justification or replacement might lead to loss of valuable information. The removal of various connectors such as MQTT, RabbitMQ, and others should be validated for relevance and impact.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Typo
    Correct grammatical errors and clarify the terminology in the new sentence

    Ensure the new sentence "Convert an http messages to HTTP webhooks" uses correct
    grammar and terminology. It should likely be "Convert HTTP messages to webhooks."

    tyk-docs/content/product-stack/tyk-streaming/key-concepts.md [84]

    -- Convert an http messages to HTTP webhooks
    +- Convert HTTP messages to webhooks
    Suggestion importance[1-10]: 7

    Why: The suggestion corrects a grammatical error and improves clarity in the documentation, which is important for reader comprehension.

    7

    Copy link

    netlify bot commented Nov 15, 2024

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

    Name Link
    🔨 Latest commit 21b30aa
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6737290b5882e100083884f4
    😎 Deploy Preview https://deploy-preview-5723--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

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

    1 similar comment
    Copy link

    netlify bot commented Nov 15, 2024

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

    Name Link
    🔨 Latest commit 21b30aa
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6737290b5882e100083884f4
    😎 Deploy Preview https://deploy-preview-5723--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

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

    @buger
    Copy link
    Member

    buger commented Nov 15, 2024

    The following ones should be kept:

    Inputs:

    • generate

    Outputs:

    • drop_on
    • fallback
    • reject
    • retry
    • switch
    • stdout

    @pvormste pvormste marked this pull request as draft November 18, 2024 13:48
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants