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 special-releases.md #5919

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update special-releases.md #5919

wants to merge 3 commits into from

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Jan 23, 2025

User description

For internal users - Please add a Jira DX PR ticket to the subject!

DX-1804


Preview Link


https://deploy-preview-5919--tyk-docs.netlify.app/

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

  • Updated LTS version announcement from April 2024 to April 2022.

  • Added a new section detailing Gateway version availability on Cloud.

  • Explained implications for unsupported Gateway versions in Cloud.

  • Provided upgrade recommendations for users on non-latest supported versions.


Changes walkthrough 📝

Relevant files
Documentation
special-releases.md
Added Gateway versioning details and updated LTS announcement

tyk-docs/content/developer-support/release-notes/special-releases.md

  • Changed LTS version announcement date to April 2022.
  • Added a new section on Gateway version availability in Cloud.
  • Detailed implications for unsupported Gateway versions.
  • Included upgrade recommendations for supported versions.
  • +26/-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

    Version Announcement Update

    The LTS version announcement date has been updated from April 2024 to April 2022. This change should be verified to ensure it aligns with the intended release schedule and does not introduce inconsistencies in the documentation.

    Our next LTS version will be announced in April 2022.
    Gateway Version Display Policy

    The new section on Gateway version availability and support in the Cloud console introduces specific policies for version selection and upgrade recommendations. Ensure these policies are accurate and align with the intended user experience and support strategy.

    ### Available Gateway Versions on Cloud
    
    To ensure a consistent and high-quality experience for our users, we have updated the way Gateway (GW) versions are displayed and supported in the Cloud console. This aligns with our Long-Term Support (LTS) policy and aims to encourage users to stay current with supported versions while reducing operational overhead for our team.
    
    **Version Availability in the Cloud Console**
    When selecting the "Latest" option, users will only be able to choose the latest feature branch (currently 5.7.x).
    
    When selecting the "LTS" option, users will be able to choose from the following:
    - Current LTS version (e.g., 5.3.x): Full support provided, with the latest patch marked as "Recommended"
    - LTS minus 1 version (e.g., 5.0.x): Maintenance support only.
    
    Older versions (e.g., 5.2.x and below) are marked as "Unsupported" and will be greyed out.
    
    **Implications for Unsupported Versions**
    Users with deployments on unsupported versions (e.g., 5.2.5) will see a notice informing them that their version is "Unsupported."
    
    Unsupported versions are not eligible for bug fixes or feature updates. Users encountering issues will be advised to upgrade to a supported version
    
    **Upgrade Recommendations**
    Users running deployments on a supported but non-latest version within a branch (e.g., 5.3.2 in the current LTS branch) will see a notice recommending an upgrade to the "Recommended" version (e.g., 5.3.4).
    
    This ensures users benefit from the latest security patches and improvements within the supported branch.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Correct outdated LTS announcement date

    Update the outdated announcement date for the next LTS version to reflect a future
    date, as the current date mentioned (April 2022) is in the past and could confuse
    readers.

    tyk-docs/content/developer-support/release-notes/special-releases.md [132]

    -Our next LTS version will be announced in April 2022.
    +Our next LTS version will be announced in April 2025.
    Suggestion importance[1-10]: 9

    Why: The suggestion addresses a critical issue of outdated information in the documentation, which could mislead readers. Updating the date to a future year ensures clarity and relevance, significantly improving the document's accuracy and utility.

    9

    Copy link

    netlify bot commented Jan 23, 2025

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

    Name Link
    🔨 Latest commit 086b0e3
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67923b8808a2a4000866428b
    😎 Deploy Preview https://deploy-preview-5919--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.

    Thanks @JoanCamosTyk! Looks good, just a few comments.

    Unsupported versions are not eligible for bug fixes or feature updates. Users encountering issues will be advised to upgrade to a supported version

    **Upgrade Recommendations**
    Users running deployments on a supported but non-latest version within a branch (e.g., 5.3.2 in the current LTS branch) will see a notice recommending an upgrade to the "Recommended" version (e.g., 5.3.4).
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Same re "recommended" version.

    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