You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
-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.
-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 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.
@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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
master
.PR Type
Documentation
Description
Changes walkthrough 📝
getting-started.md
Add feedback section with CTA button in Getting Started guide
tyk-docs/content/product-stack/tyk-streaming/getting-started.md
Streams.
overview.md
Add Express Your Interest section with CTA button in Overview
tyk-docs/content/product-stack/tyk-streaming/overview.md
interest feedback.