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.25.0.md #5913

Closed
wants to merge 1 commit into from
Closed

Update cloud 1.25.0.md #5913

wants to merge 1 commit into from

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Jan 21, 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 version 1.25.

  • Included placeholders for highlights, breaking changes, and deprecations.

  • Provided a download link for the latest Mserv version.

  • Structured changelog section for fixed issues and customer impact.


Changes walkthrough 📝

Relevant files
Documentation
cloud.md
Added release notes for version 1.25.                                       

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

  • Added a new section for 1.25 release notes.
  • Included placeholders for breaking changes and deprecations.
  • Added a download link for Mserv.
  • Structured changelog for fixed issues and customer impact.
  • +31/-0   

    💡 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

    Missing Release Date

    The release date for version 1.25 is marked as "xx of February 2025". This placeholder should be replaced with the actual release date to ensure clarity and accuracy.

    #### Release Date xx of February 2025
    Placeholder Changelog

    The changelog section for version 1.25 contains placeholders and lacks actual content. Ensure that the changelog is updated with specific details about the fixed issues, benefits, and customer impact as per the provided guidelines.

    #### 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" -->
    
    ##### 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. -->

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Specify the exact release date

    Specify the exact release date for the "1.25 Release Notes" to avoid ambiguity and
    ensure clarity for readers.

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

    -#### Release Date xx of February 2025
    +#### Release Date 15th of February 2025
    Suggestion importance[1-10]: 7

    Why: Providing an exact release date improves clarity and avoids ambiguity for readers. While the suggestion is valid and enhances the documentation, it is not critical and could be addressed later if necessary.

    7

    @JoanCamosTyk
    Copy link
    Contributor Author

    Duplicate

    Copy link

    netlify bot commented Jan 21, 2025

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

    Name Link
    🔨 Latest commit 8d630b2
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/678fb7d16d67d0000862ba2d
    😎 Deploy Preview https://deploy-preview-5913--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.

    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.

    1 participant