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

Update overview.md DX-1811 #5977

Closed
wants to merge 1 commit into from
Closed

Conversation

sophieriches
Copy link
Contributor

@sophieriches sophieriches commented Feb 7, 2025

User description

Removed link to HS form

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



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.
  • For Tyk Members - Please add a Jira DX PR ticket to the subject!
  • For Tyk Members - I have added the appropriate release label to this PR:
    • If it is for a future release, label it as future-release and specify the version (e.g., future-release, 6.0).
    • If it should be merged into an older version, use the specific version label (e.g., 4.1, 5.1).
    • If no label is added, it will be assumed that the PR should be merged into the latest current version (e.g., 5.5) and master.

PR Type

Documentation


Description

  • Removed the link to the HS form in the "Getting started" section.

  • Updated instructions to contact account managers for Tyk Streams details.

  • Fixed a minor formatting issue in a section title.


Changes walkthrough 📝

Relevant files
Documentation
overview.md
Update Tyk Streaming overview content and formatting         

tyk-docs/content/product-stack/tyk-streaming/overview.md

  • Removed the HS form link from the "Getting started" section.
  • Updated guidance to contact account managers for details.
  • Corrected formatting in the "How Tyk Streams Enables Async API
    Support" section title.
  • +2/-4     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Removed link to HS form
    Copy link
    Contributor

    github-actions bot commented Feb 7, 2025

    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

    Possible Content Clarity Issue

    The new text added in the "Getting started" section removes the call-to-action button and replaces it with a generic instruction to contact an account manager. This might reduce user engagement or clarity on how to proceed. Consider whether this change aligns with the intended user experience.

    Our first release of Tyk Streams is now available, please reach out to your account manager to get all the details to try it out. 
    Grammar/Formatting Issue

    The header "How Tyk Streams Enables Async API Support" has been updated, but the question mark was removed. Ensure this change aligns with the intended tone and style of the documentation.

    ## How Tyk Streams Enables Async API Support

    Copy link
    Contributor

    github-actions bot commented Feb 7, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Add a clear call-to-action link

    Add a clear call-to-action or link for users to easily access more information or
    sign up for Tyk Streams, as the new text removes the actionable button from the
    previous version.

    tyk-docs/content/product-stack/tyk-streaming/overview.md [96]

    -Our first release of Tyk Streams is now available, please reach out to your account manager to get all the details to try it out.
    +Our first release of Tyk Streams is now available. Please reach out to your account manager to get all the details to try it out, or click here to sign up and explore it further: [Get started with Tyk Streams](https://survey.hsforms.com/1ItPCBg-_Tre8WFJZL4pp6Q3ifmg).
    Suggestion importance[1-10]: 8

    __

    Why: The suggestion restores a clear call-to-action link that was removed in the PR, improving user experience by providing an actionable step for users to sign up or explore Tyk Streams further. This is a significant enhancement to the documentation's usability and accessibility.

    Medium

    Copy link

    netlify bot commented Feb 7, 2025

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

    Name Link
    🔨 Latest commit 69815d1
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67a6711b963b3e0008f51976
    😎 Deploy Preview https://deploy-preview-5977--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 Feb 7, 2025

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

    Name Link
    🔨 Latest commit 69815d1
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67a6711b963b3e0008f51976
    😎 Deploy Preview https://deploy-preview-5977--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.

    @sharadregoti
    Copy link
    Contributor

    Closing this PR in favor of #5984.

    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