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 mdcb 2.8.md #6005

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Update mdcb 2.8.md #6005

wants to merge 5 commits into from

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Feb 19, 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

  • Added detailed release notes for MDCB version 2.8.

  • Included release highlights, breaking changes, and dependencies.

  • Provided upgrade instructions and download links for version 2.8.0.

  • Clarified deprecations and changelog structure for the release.


Changes walkthrough 📝

Relevant files
Documentation
mdcb.md
Added MDCB 2.8 release notes and upgrade details                 

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

  • Added a new section for MDCB 2.8 release notes.
  • Included dependency details for Redis, MongoDB, and PostgreSQL.
  • Provided upgrade instructions and Docker image download link.
  • Clarified no breaking changes or deprecations in this release.
  • +35/-0   

    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

    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 2.8 is marked as "xxx". This placeholder should be replaced with the actual release date to ensure clarity and accuracy in the documentation.

    ### Release Date xxx
    Upgrade Instructions Clarity

    The upgrade instructions mention bypassing version 2.8.0 for older versions but lack detailed reasoning or context. This could confuse users and should be clarified.

    #### Upgrade instructions
    For users currently on v2.7.2, we strongly recommend promptly upgrading to the latest release. If you are working with an older version (lower minor), it is advisable to bypass version 2.8.0 and proceed directly to this latest patch release.
    <br/>
    Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade Instructions.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Add missing release date information

    Specify the release date for version 2.8 in the "Release Date" section to avoid
    ambiguity and provide complete information to the users.

    tyk-docs/content/developer-support/release-notes/mdcb.md [31]

    -### Release Date xxx
    +### Release Date February 19, 2025
    Suggestion importance[1-10]: 8

    __

    Why: Adding the release date provides crucial information for users and avoids ambiguity. This is a significant improvement for documentation clarity and completeness.

    Medium
    Clarify the changelog section content

    Ensure the "Changelog" section includes actual changes or a placeholder indicating
    no changes, to avoid confusion for users.

    tyk-docs/content/developer-support/release-notes/mdcb.md [62]

     #### Changelog {#Changelog-v2.7.2}
    +- No changes in this release.
    Suggestion importance[1-10]: 7

    __

    Why: Including a placeholder or actual changes in the changelog section ensures users are not confused by an empty or unclear section. This enhances the usability and professionalism of the documentation.

    Medium

    Copy link

    netlify bot commented Feb 19, 2025

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

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

    @sharadregoti sharadregoti marked this pull request as draft February 20, 2025 09:15
    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