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

Tyk Chart 2.2 release #5719

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

Tyk Chart 2.2 release #5719

wants to merge 7 commits into from

Conversation

caroltyk
Copy link
Contributor

@caroltyk caroltyk commented Nov 14, 2024

User description

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



Preview Link


https://deploy-preview-5719--tyk-docs.netlify.app/docs/nightly/product-stack/tyk-charts/release-notes/version-2.2/

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, Enhancement


Description

  • Added comprehensive release notes for Tyk Charts version 2.2, detailing new features, enhancements, and fixed issues.
  • Introduced new configurations for audit logs and Open Policy Agent (OPA) in Tyk Dashboard.
  • Added support for OpenTelemetry and customizable liveness and readiness probes for Tyk Gateway.
  • Updated the documentation menu to include a link to the Tyk Charts 2.2 release notes.

Changes walkthrough 📝

Relevant files
Documentation
version-2.2.md
Added release notes for Tyk Charts version 2.2                     

tyk-docs/content/product-stack/tyk-charts/release-notes/version-2.2.md

  • Added release notes for Tyk Charts version 2.2.
  • Documented new features, enhancements, and fixed issues.
  • Included upgrade instructions and download links.
  • Provided a detailed changelog with added, changed, and fixed sections.

  • +290/-0 
    menu.yaml
    Updated menu with Tyk Charts 2.2 release notes                     

    tyk-docs/data/menu.yaml

    • Added menu entry for Tyk Charts 2.2 release notes.
    +4/-0     
    Enhancement
    tyk-control-plane-chart.md
    Added audit log and OPA configurations for Dashboard         

    tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md

  • Added audit log configurations for Tyk Dashboard.
  • Introduced OPA configurations for Tyk Dashboard.
  • +19/-0   
    tyk-data-plane-chart.md
    Added OpenTelemetry and probes configuration for Gateway 

    tyk-docs/content/product-stack/tyk-charts/tyk-data-plane-chart.md

  • Added OpenTelemetry configuration for Gateway.
  • Added liveness and readiness probes configuration for Gateway.
  • +12/-0   
    tyk-oss-chart.md
    Added OpenTelemetry and probes configuration for Gateway 

    tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md

  • Added OpenTelemetry configuration for Gateway.
  • Added liveness and readiness probes configuration for Gateway.
  • +12/-0   
    tyk-stack-chart.md
    Added probes, audit log, and OPA configurations                   

    tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md

  • Added liveness and readiness probes configuration for Gateway.
  • Added audit log configurations for Tyk Dashboard.
  • Introduced OPA configurations for Tyk Dashboard.
  • +24/-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: 4 🔵🔵🔵🔵⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Placeholder Content
    The release date and some content placeholders need to be updated before finalizing the release notes.

    Documentation Link
    Ensure that all documentation links are valid and lead to the correct resources.

    Code Comment
    There are commented sections that might be either removed or clarified if they are intended to be instructions for further edits.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 14, 2024

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

    Name Link
    🔨 Latest commit da8488d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673f01667ea7790008c0f396
    😎 Deploy Preview https://deploy-preview-5719--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.


    ## 2.2.0 Release Notes

    ### Release Date DD Mon YYYY <<update>>
    Copy link
    Contributor

    @sharadregoti sharadregoti Nov 21, 2024

    Choose a reason for hiding this comment

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

    Suggested change
    ### Release Date DD Mon YYYY <<update>>
    ### Release Date 24 Nov 2024

    TODO: Change date when merging the PR.

    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