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

Merging to release-5.4: [DX-1463] add signup and feedback links (#5064) #5068

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jul 12, 2024

User description

DX-1463 add signup and feedback links (#5064)

  • add signu and feedback

  • rephrase and added signup

  • rephrase message

  • rephrase based on PR Agent ai

  • rephrase based on PR Agent ai and shorten lines

  • Revert "rephrase based on PR Agent ai and shorten lines"

This reverts commit 5826395.

  • fix sentence

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

  • Update key-concepts.md


PR Type

Enhancement, Documentation


Description

  • Added feedback request sections with links to surveys in multiple documents.
  • Included notes about the Lab Release phase and provided signup links.
  • Improved formatting and readability across the documentation.
  • Updated sections on protocol mediation, connectors, and configuration.

Changes walkthrough 📝

Relevant files
Documentation
getting-started.md
Added feedback request and success note in getting started guide

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

  • Added a feedback request section with a link to a survey.
  • Added success note after setup completion.
  • Updated next steps to include a feedback request.
  • +25/-6   
    key-concepts.md
    Added Lab Release note and improved readability in key concepts

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

  • Added a note about the Lab Release phase with a signup link.
  • Improved formatting and readability.
  • Updated protocol mediation and connectors section.
  • +45/-26 
    overview.md
    Added getting started section and improved overview readability

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

  • Added a getting started section with a signup link.
  • Improved formatting and readability.
  • Updated configuration and comparison sections.
  • +33/-9   

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

    * add signu and feedback
    
    * rephrase and added signup
    
    * rephrase message
    
    * rephrase based on PR Agent ai
    
    * rephrase based on PR Agent ai and shorten lines
    
    * Revert "rephrase based on PR Agent ai and shorten lines"
    
    This reverts commit 5826395.
    
    * fix sentence
    
    * Update tyk-docs/content/product-stack/tyk-streaming/overview.md
    
    * Update key-concepts.md
    
    (cherry picked from commit 2c867cf)
    Copy link
    Contributor

    PR Reviewer Guide 🔍

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

    Markdown Syntax:
    Ensure that the custom Markdown syntax used for buttons and notes ({{< button_left ... >}}, {{< note success>}}) is supported by the Markdown renderer in use. If not, these elements may not display as intended.

    Line Breaks:
    The use of </br> for line breaks is not standard Markdown and might not render correctly depending on the Markdown processor used. Consider using standard Markdown line breaks (double space at the end of a line or double newline).

    External Links:
    The PR includes several external links (e.g., to surveys). Verify that these links are correct, accessible, and intended for public use.

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Remove redundant feedback button to enhance user experience

    Consider removing the repeated feedback button to avoid redundancy and streamline
    the user experience.

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

    -{{< button_left href="https://survey.hsforms.com/1lb_eMrtRR5W3WoEEuACQ2Q3ifmg" color="green" content="Feedback" >}}
    +(Remove this line)
     
    Suggestion importance[1-10]: 8

    Why: Removing the redundant feedback button enhances user experience by reducing clutter and avoiding repetitive elements.

    8
    Maintainability
    Use Markdown syntax for notes for better maintainability

    Consider using Markdown syntax for notes instead of HTML comments to keep the
    document cleaner and more maintainable.

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

    -{{< note success>}}
    +> **Note:**
     
    Suggestion importance[1-10]: 7

    Why: Using Markdown syntax for notes improves maintainability and readability, but the existing HTML-based syntax is also valid and commonly used in Markdown files.

    7

    Copy link

    netlify bot commented Jul 12, 2024

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

    Name Link
    🔨 Latest commit 1feba9c
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6690c6d363799e0008a0d87a
    😎 Deploy Preview https://deploy-preview-5068--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 buger merged commit b520634 into release-5.4 Jul 12, 2024
    10 checks passed
    @buger buger deleted the merge/release-5.4/2c867cf6314b7bdd68e783c293d3e8630d4cb4db branch July 12, 2024 06:04
    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