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

Operator 1.1 RN #5741

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

Operator 1.1 RN #5741

wants to merge 2 commits into from

Conversation

caroltyk
Copy link
Contributor

@caroltyk caroltyk commented Nov 21, 2024

User description

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



Preview Link


https://deploy-preview-5741--tyk-docs.netlify.app/docs/nightly/product-stack/tyk-operator/release-notes/operator-1.1/

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 comprehensive release notes for Tyk Operator v1.1, detailing new features, enhancements, and upgrade instructions.
  • Introduced support for Tyk Streams API through a new custom resource, TykStreamsApiDefinition.
  • Updated the release notes overview and menu to include links to the new v1.1 release notes.

Changes walkthrough 📝

Relevant files
Documentation
operator-1.1.md
Add Tyk Operator v1.1 Release Notes                                           

tyk-docs/content/product-stack/tyk-operator/release-notes/operator-1.1.md

  • Added release notes for Tyk Operator v1.1.
  • Documented support for Tyk Streams API.
  • Included upgrade instructions and download links.
  • Provided a changelog with new features.
  • +230/-0 
    overview.md
    Update Release Notes Overview with v1.1                                   

    tyk-docs/content/product-stack/tyk-operator/release-notes/overview.md

    • Added link to Tyk Operator v1.1 release notes.
    +1/-0     
    menu.yaml
    Update Menu with Tyk Operator v1.1 Entry                                 

    tyk-docs/data/menu.yaml

    • Added menu entry for Tyk Operator v1.1 release notes.
    +4/-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: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Placeholder Content
    The release notes contain placeholders such as "XX Nov 2024 (TBD)" and "Learn More: TBD" which need to be finalized before publishing.

    Compatibility Matrix Missing
    The section for the compatibility matrix is commented out and marked as "TBP - to be published". This needs to be completed or updated with actual data before release.

    Incomplete Sections
    Several sections are marked with placeholders or are incomplete, such as the upgrade instructions and the changelog details. These sections need to be fully detailed to provide clear guidance and information to users.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 21, 2024

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

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