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 cloud 1.24.2.md #5887

Merged
merged 7 commits into from
Jan 14, 2025
Merged

Update cloud 1.24.2.md #5887

merged 7 commits into from
Jan 14, 2025

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Jan 13, 2025

User description

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.
  • I labeled the PR

PR Type

Documentation


Description

  • Added release notes for Tyk Cloud version 1.24.2.

  • Highlighted fixes for Telemetry export configuration issues.

  • Clarified no breaking changes or deprecations in the release.

  • Provided download link for the latest Mserv version.


Changes walkthrough 📝

Relevant files
Documentation
cloud.md
Updated release notes for Tyk Cloud 1.24.2                             

tyk-docs/content/developer-support/release-notes/cloud.md

  • Added release notes for version 1.24.2.
  • Detailed fixes for Telemetry export configuration.
  • Included release highlights and breaking changes section.
  • Added download link for Mserv and clarified no deprecations.
  • +48/-1   

    💡 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

    Documentation Clarity

    Ensure that the explanation of the fixed Telemetry export configuration issue is clear and provides sufficient detail for users to understand the impact and resolution.

    This Tyk Cloud update resolves an issue related to Telemetry export configurations. Previously, when deploying a Data Plane in a region different from the Control Plane, Telemetry export settings could encounter compatibility issues. With this patch, Telemetry export configuration now works seamlessly across regional deployments, ensuring consistent observability for distributed Tyk Cloud setups.
    
    
    ### Breaking Changes
    <!-- Required. Use the following statement if there are no breaking changes, or explain if there are -->
    There are no breaking changes in this release
    
    ### Downloads
    - [latest version of Mserv](https://github.com/TykTechnologies/mserv/releases/latest)
    
    ### Deprecations
    <!-- Required. Use the following statement if there are no deprecations, or explain if there are -->
    There are no deprecations in this release
    
    ##### Fixed
    <!-- This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
    - What problem the issue caused
    - How was the issue fixed
    - Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
    - For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
    Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
    
    <ul>
      <li>
        <details>
          <summary>
            Fixed Telemetry export configuration for cross-region deployments
          </summary>
          The Telemetry export configuration now functions as expected when a Data Plane is deployed in a region different from the Control Plane, ensuring compatibility across distributed setups.
    Changelog Formatting

    Verify that the changelog formatting and structure adhere to the required guidelines, ensuring consistency and readability for users.

    #### Changelog {#Changelog-v1.23.0}
    <!-- Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
    Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
    "...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
    "New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" --

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Include a reference link to GitHub or documentation for the fixed issue to provide users with additional context

    Ensure that the "Fixed" section includes a GitHub issue link or documentation
    reference for users to access further details about the fix.

    tyk-docs/content/developer-support/release-notes/cloud.md [40-49]

     <ul>
       <li>
         <details>
           <summary>
             Fixed Telemetry export configuration for cross-region deployments
           </summary>
    -      The Telemetry export configuration now functions as expected when a Data Plane is deployed in a region different from the Control Plane, ensuring compatibility across distributed setups.
    +      The Telemetry export configuration now functions as expected when a Data Plane is deployed in a region different from the Control Plane, ensuring compatibility across distributed setups. For more details, see [GitHub Issue #12345](https://github.com/TykTechnologies/tyk/issues/12345).
         </details>
       </li>
     </ul>
    Suggestion importance[1-10]: 9

    Why: Including a reference link to the GitHub issue or documentation provides valuable context and traceability for users, which is especially important for technical documentation and issue resolution transparency.

    9
    Standardize the release date format for consistency across the document

    Ensure that the release date format is consistent throughout the document to avoid
    confusion, as "13 of January 2025" deviates from the standard format used elsewhere.

    tyk-docs/content/developer-support/release-notes/cloud.md [14]

    -### Release Date 13 of January 2025
    +### Release Date January 13, 2025
    Suggestion importance[1-10]: 8

    Why: The suggestion improves consistency and readability by aligning the release date format with standard conventions, which is beneficial for clarity and professionalism.

    8
    Provide context for the download link to improve clarity for users

    Add a brief explanation or context for the "latest version of Mserv" link to clarify
    its relevance and purpose for the user.

    tyk-docs/content/developer-support/release-notes/cloud.md [26]

    -- [latest version of Mserv](https://github.com/TykTechnologies/mserv/releases/latest)
    +- [latest version of Mserv](https://github.com/TykTechnologies/mserv/releases/latest) - Download the latest version of Mserv for managing Tyk Cloud services.
    Suggestion importance[1-10]: 7

    Why: Adding context to the download link enhances user understanding and ensures the purpose of the link is clear, improving the overall usability of the document.

    7

    Copy link

    netlify bot commented Jan 13, 2025

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

    Name Link
    🔨 Latest commit e29ebe8
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/678528018d72800007895a82
    😎 Deploy Preview https://deploy-preview-5887--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 Jan 13, 2025

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

    Name Link
    🔨 Latest commit d8c9cd3
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67866f7bb390190008bac87e
    😎 Deploy Preview https://deploy-preview-5887--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
    Member

    @excieve excieve left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM, thanks!

    Copy link
    Member

    @excieve excieve left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM

    @sharadregoti sharadregoti merged commit 3e6a174 into master Jan 14, 2025
    9 checks passed
    @sharadregoti sharadregoti deleted the JoanCamosTyk-patch-4 branch January 14, 2025 14:10
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.7

    Copy link

    tykbot bot commented Jan 14, 2025

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Jan 14, 2025
    (cherry picked from commit 3e6a174)
    Copy link

    tykbot bot commented Jan 14, 2025

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Jan 14, 2025
    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.

    3 participants