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

Helm Chart 3.0 release notes #6052

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

Helm Chart 3.0 release notes #6052

wants to merge 4 commits into from

Conversation

caroltyk
Copy link
Contributor

@caroltyk caroltyk commented Mar 3, 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.
  • For Tyk Members - Please add a Jira DX PR ticket to the subject!
  • For Tyk Members - I have added the appropriate release label to this PR:
    • If it is for a future release, label it as future-release and specify the version (e.g., future-release, 6.0).
    • If it should be merged into an older version, use the specific version label (e.g., 4.1, 5.1).
    • If no label is added, it will be assumed that the PR should be merged into the latest current version (e.g., 5.5) and master.

PR Type

  • Documentation

Description

  • Updated front matter metadata (description, tags).

  • Added comprehensive Helm Chart 3.0 release notes.

  • Detailed sections on breaking changes, dependencies, and upgrades.

  • Included extensive changelog with added, changed, and fixed updates.


Changes walkthrough 📝

Relevant files
Documentation
helm-chart.md
Add comprehensive Helm Chart 3.0 release notes                     

tyk-docs/content/developer-support/release-notes/helm-chart.md

  • Updated metadata for release notes.
  • Inserted full release notes section for version 3.0.
  • Detailed subsections: breaking changes, dependencies, upgrade
    instructions, downloads.
  • Provided in-depth changelog for added, changed and fixed items.
  • +256/-2 

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    github-actions bot commented Mar 3, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Placeholder

    The release notes include placeholders (e.g., "XX March 2025") that should be updated with actual values before finalizing the document.

    #### Release Date XX March 2025
    
    Clarity

    Some phrasing (for example, "Tyk Charts 3.0 introduces a breaking configuration changes") could be reworded for clarity and grammatical accuracy.

    Tyk Charts 3.0 introduces a breaking configuration changes for Tyk Dashboard: To provide a default secure configuration, `security.forbid_admin_view_access_token` and `security.forbid_admin_reset_access_token` are set to `true` to restrict admin users from being able to view and reset other users' Dashboard API Access Credentials.

    Copy link
    Contributor

    github-actions bot commented Mar 3, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Update release date placeholder

    Replace the placeholder "XX" in the release date with the actual day to avoid
    misleading readers.

    tyk-docs/content/developer-support/release-notes/helm-chart.md [29]

    -#### Release Date XX March 2025
    +#### Release Date 03 March 2025
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion addresses a placeholder that could mislead readers, improving clarity, though it only impacts documentation text.

    Low
    Fix breaking changes grammar

    Remove the extra article "a" for grammatical correctness in the breaking changes
    section.

    tyk-docs/content/developer-support/release-notes/helm-chart.md [41]

    -Tyk Charts 3.0 introduces a breaking configuration changes for Tyk Dashboard:
    +Tyk Charts 3.0 introduces breaking configuration changes for Tyk Dashboard:
    Suggestion importance[1-10]: 5

    __

    Why: Removing the extra article corrects a grammatical error in a key explanatory sentence, resulting in clearer syntax with moderate impact.

    Low
    Correct deprecation text

    Update the deprecation statement to use the proper plural form.

    tyk-docs/content/developer-support/release-notes/helm-chart.md [99]

    -There are no deprecation in this release.
    +There are no deprecations in this release.
    Suggestion importance[1-10]: 5

    __

    Why: Updating the plural form in the deprecation statement improves grammatical accuracy, providing a minor yet useful textual fix.

    Low

    Copy link

    netlify bot commented Mar 3, 2025

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

    Name Link
    🔨 Latest commit d3e6277
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67c63af198814300088cf7ae
    😎 Deploy Preview https://deploy-preview-6052--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 Mar 3, 2025

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

    Name Link
    🔨 Latest commit 54b59f4
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67d135a2b3f892000883cfa2
    😎 Deploy Preview https://deploy-preview-6052--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.

    Comment on lines 38 to 39
    <!-- Required. Use the following statement if there are no breaking changes, or explain if there are
    This release has no breaking changes.-->
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Please remove the comments on this page. Refer to the condensed release note template.


    ### 3.0.0 Release Notes

    #### Release Date XX March 2025
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    Suggested change
    #### Release Date XX March 2025
    #### Release Date XX March 2025

    TODO: Fix this before merging

    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