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

[DX-1463] Add Tyk Streams Survey Links #5044

Closed
wants to merge 10 commits into from
Closed

[DX-1463] Add Tyk Streams Survey Links #5044

wants to merge 10 commits into from

Conversation

dcs3spp
Copy link
Contributor

@dcs3spp dcs3spp commented Jul 9, 2024

User description

DX-1463


Preview Link

overview preview
getting started preview
key concepts

Description

Add CTA buttons to Tyk Streams surveys

Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • 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 labelled the PR

PR Type

Documentation


Description

  • Added a feedback section with a CTA button in the "Getting Started" guide for Tyk Streams.
  • Introduced an "Express Your Interest" section with a CTA button in the Tyk Streams Overview.
  • Reorganized content to integrate the new sections seamlessly.

Changes walkthrough 📝

Relevant files
Documentation
getting-started.md
Add feedback section with CTA button in Getting Started guide

tyk-docs/content/product-stack/tyk-streaming/getting-started.md

  • Added a feedback section with a CTA button for user feedback on Tyk
    Streams.
  • Updated introductory text to include the feedback section.
  • +8/-1     
    overview.md
    Add Express Your Interest section with CTA button in Overview

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

  • Added an "Express Your Interest" section with a CTA button for user
    interest feedback.
  • Reorganized content to include the new section.
  • +13/-1   

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

    @dcs3spp dcs3spp changed the title [DX-1463] Draft commit for Tyk Streams surveys [DX-1463] Tyk Streams surveys Jul 9, 2024
    Copy link

    netlify bot commented Jul 9, 2024

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

    Name Link
    🔨 Latest commit 782c831
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/668d6177b4ad08000853da56
    😎 Deploy Preview https://deploy-preview-5044--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.

    Copy link

    netlify bot commented Jul 9, 2024

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

    Name Link
    🔨 Latest commit f3eddc6
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/668ff74a96564e0007a480e7
    😎 Deploy Preview https://deploy-preview-5044--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.

    @dcs3spp dcs3spp requested a review from letzya July 9, 2024 16:20
    @dcs3spp dcs3spp changed the title [DX-1463] Tyk Streams surveys [DX-1463] Add Tyk Streams Survey Links Jul 9, 2024
    @dcs3spp dcs3spp marked this pull request as ready for review July 9, 2024 16:29
    Copy link
    Contributor

    github-actions bot commented Jul 9, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Markdown Formatting:
    The use of <br> in Markdown files is not standard and might not render as expected in all Markdown processors. Consider using standard Markdown line breaks (double space at the end of a line) or paragraphs.

    External Link Dependency:
    The PR introduces external links to surveys. Ensure these links are stable and will not change frequently to avoid broken links in the documentation.

    Copy link
    Contributor

    github-actions bot commented Jul 9, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Replace HTML line break with Markdown's native line break

    Replace the
    tag with Markdown's native line break syntax for better compatibility
    and consistency across different Markdown renderers.

    tyk-docs/content/product-stack/tyk-streaming/getting-started.md [13]

    -</br>
     
    +
    Suggestion importance[1-10]: 8

    Why: Replacing the HTML line break with Markdown's native line break improves compatibility and consistency across different Markdown renderers, which is a best practice for Markdown files.

    8
    Enhancement
    Enhance the call-to-action in the feedback request to boost engagement

    Consider adding a direct call-to-action in the feedback section to encourage more
    user interactions.

    tyk-docs/content/product-stack/tyk-streaming/getting-started.md [11]

    -We value your feedback. Please use the following survey to provide feedback on your experience so far with Tyk Streams.
    +We value your feedback. To help us improve, please take a few minutes to complete the following survey about your experience with Tyk Streams. Your insights are invaluable!
     
    Suggestion importance[1-10]: 7

    Why: The improved call-to-action is more engaging and likely to encourage users to provide feedback, which can be valuable for improving the product.

    7
    Readability
    Use bullet points to list supported platforms for better readability

    To enhance readability and maintain a consistent style, consider using bullet points
    to list the various event brokers and streaming platforms supported by Tyk Streams.

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

    -With *Tyk Streams*, you can easily connect to various event brokers and streaming platforms, such as [Apache Kafka](https://github.com/TykTechnologies/tyk-pro-docker-demo/tree/kafka), MQTT, AMQP etc. and expose them as managed API endpoints to internal and external consumers.
    +With *Tyk Streams*, you can easily connect to various event brokers and streaming platforms, exposing them as managed API endpoints to internal and external consumers. Supported platforms include:
    +- [Apache Kafka](https://github.com/TykTechnologies/tyk-pro-docker-demo/tree/kafka)
    +- MQTT
    +- AMQP
     
    Suggestion importance[1-10]: 6

    Why: Using bullet points enhances readability and maintains a consistent style, making it easier for readers to quickly grasp the supported platforms.

    6
    Maintainability
    Merge introductory sentences to streamline content and avoid redundancy

    To avoid redundancy and streamline the content, consider merging the introductory
    sentences of the new section with the existing content about Tyk Streams'
    capabilities.

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

    -*Tyk Streams* is a powerful new feature in the Tyk API management platform that enables organisations to securely expose, manage and monetize real-time event streams and asynchronous APIs.
    -With *Tyk Streams*, you can easily connect to various event brokers and streaming platforms, such as [Apache Kafka](https://github.com/TykTechnologies/tyk-pro-docker-demo/tree/kafka), MQTT, AMQP etc. and expose them as managed API endpoints to internal and external consumers.
    +Introducing *Tyk Streams*, a powerful new feature of the Tyk API management platform that enables organisations to securely expose, manage, and monetize real-time event streams and asynchronous APIs. Connect easily to various event brokers and streaming platforms like [Apache Kafka](https://github.com/TykTechnologies/tyk-pro-docker-demo/tree/kafka), MQTT, AMQP, etc., and expose them as managed API endpoints to both internal and external consumers.
     
    Suggestion importance[1-10]: 5

    Why: Merging the introductory sentences helps streamline the content and avoid redundancy, improving the overall readability and maintainability of the document.

    5

    @dcs3spp
    Copy link
    Contributor Author

    dcs3spp commented Jul 11, 2024

    @letzya I have updated the overview page to include signup button mentioning get started. On the overview page I have also added a link to signup in the lab release note.

    Next, I will update the button and text on getting started page to make it clearer that it is a survey after getting started and will add the same labs release note to key concepts page

    @dcs3spp dcs3spp force-pushed the dx-1463 branch 2 times, most recently from 80583bd to 8356343 Compare July 11, 2024 13:55
    @letzya
    Copy link
    Collaborator

    letzya commented Jul 12, 2024

    closed in favour of #5068

    @letzya letzya closed this Jul 12, 2024
    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