[DX-1507] Gateway 5.3.3 release notes

[Eopayemi]

User description

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

DX-1507

---

Preview Link

Preview

Description

5.3.3 release notes for gateway

Screenshots (if appropriate)

Checklist

• I have added a preview link to the PR description.
• 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 labelled the PR

---

PR Type

Documentation, Enhancement

---

Description

• Added comprehensive release notes for Tyk Gateway version 5.3.3.
• Included detailed sections for breaking changes, deprecations, upgrade instructions, release highlights, dependencies, downloads, and changelog.
• Updated tags to reflect the new version 5.3.3.

---

Changes walkthrough 📝

	Relevant files
Documentation	version-5.3.md Added release notes for Tyk Gateway version 5.3.3                tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md Added release notes for Tyk Gateway version 5.3.3. Included sections for breaking changes, deprecations, upgrade instructions, release highlights, dependencies, downloads, and changelog. Updated tags to include version 5.3.3. +135/-1

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

(Review updated until commit c5b3a8c)

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Documentation Clarity The release date for version 5.3.3 is marked as 'xxx', which seems to be a placeholder. This should be replaced with the actual release date to avoid confusion. Link Verification The links using '{{< ref "#TykOAS-v5.3.0">}}' and similar might not resolve correctly due to the use of placeholders or incorrect syntax. Ensure all links are correctly formatted and functional. Content Completeness The 'Release Highlights' section mentions a detailed changelog below, but the actual changelog entries are quite brief. Consider expanding these entries to include more detailed information about the changes, especially how they impact the user.

[netlify]

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

Name	Link
🔨 Latest commit	050f2fb
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66acb87d26745600077a210f
😎 Deploy Preview	https://deploy-preview-5057--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[dcs3spp]

Thanks @Eopayemi PR LGTM, as you have mentioned, PR needs updating with release date once available. I have made minor observations/suggestions on the PR relating to captilisation of changelog items in fixes section

[github-actions]

Persistent review updated to latest commit c5b3a8c

[github-actions]

PR Code Suggestions ✨

Latest suggestions up to c5b3a8c

Category	Suggestion	Score
Possible bug	Verify and correct the link to the 'Upgrading Tyk' section to ensure it is functional To improve navigation and user experience, ensure that the link provided in the upgrade instructions is functional and correctly redirects to the 'Upgrading Tyk' section, as currently, it appears to be a placeholder. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [40] -Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade instructions. +Go to the [Upgrading Tyk](actual-link-to-upgrading-section) section for detailed upgrade instructions. Suggestion importance[1-10]: 10 Why: Ensuring that links are functional is critical for user navigation and experience. A broken link can significantly hinder the usability of the documentation.	10
Possible issue	Ensure the release date section is accurately completed or marked as pending To ensure the release date section is complete before merging, replace the placeholder 'xxx' with the actual release date or remove the placeholder if the date is not yet determined. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [26] -### Release Date xxx +### Release Date [actual release date] Suggestion importance[1-10]: 9 Why: Ensuring the release date is accurately completed or marked as pending is crucial for the document's accuracy and completeness. This addresses a potential issue that could cause confusion.	9
Enhancement	Improve consistency in version tagging by adjusting the tag format It's recommended to maintain consistency in the tag naming convention. The tag '5.3' should be replaced with 'v5.3' to match the format used for other version tags in the list. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [5] -tags: ["Tyk Gateway", "Release notes", "v5.3", "5.3.0", "5.3.1", "5.3.3", "changelog"] +tags: ["Tyk Gateway", "Release notes", "v5.3", "5.3.0", "5.3.1", "v5.3.3", "changelog"] Suggestion importance[1-10]: 8 Why: The suggestion improves consistency in the version tagging, which enhances readability and maintains a standard format. This is a minor but useful enhancement.	8
Clarity	Add explicit mentions of no breaking changes or deprecations in the release highlights for clarity To enhance clarity and avoid potential confusion, explicitly mention the absence of deprecations and breaking changes in the release highlights section, instead of only detailing them under their respective headings. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [44] -This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.3">}}) below. +This release primarily focuses on bug fixes and contains no breaking changes or deprecations. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.3">}}) below. Suggestion importance[1-10]: 7 Why: This suggestion improves clarity by explicitly stating the absence of breaking changes and deprecations in the release highlights, which can help users quickly understand the scope of the release.	7

---

Previous suggestions

Suggestions up to commit 87fe820

Category	Suggestion	Score
Possible issue	Replace placeholder with the actual release date to provide complete and accurate information The placeholder 'xxx' for the release date should be replaced with the actual release date to avoid publishing incomplete information. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [26] -### Release Date xxx +### Release Date 2024-03-28 Suggestion importance[1-10]: 10 Why: Replacing the placeholder with the actual release date is crucial to avoid publishing incomplete information, making this a high-priority fix.	10
Enhancement	Maintain consistency in version tagging by including both general and specific version tags It's recommended to maintain consistency in the version tags. The tag '5.3' was removed and '5.3.3' was added. If '5.3' is intended to represent all minor versions under 5.3, it should be kept alongside specific patch versions like '5.3.3'. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [5] +tags: ["Tyk Gateway", "Release notes", "v5.3", "5.3.0", "5.3.1", "5.3.3", "changelog"] - Suggestion importance[1-10]: 9 Why: The suggestion is correct and improves the consistency of the version tags, which is important for clarity and documentation accuracy.	9
Possible bug	Correct the formatting of the internal link to ensure it is not broken Ensure that the link to the '5.3.0 release' is correctly formatted to avoid broken links in the documentation. tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.3.md [33] -[5.3.0 release]({{< ref "#TykOAS-v5.3.0">}}) +[5.3.0 release](#TykOAS-v5.3.0) Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies and fixes a potential issue with a broken link, which is important for maintaining the integrity of the documentation.	8

[dcs3spp]

Thanks @Eopayemi I have approved and once release date added and PM approved will merge and release

[dcs3spp]

Remember to add release date

[dcs3spp]

/release to release-5.4

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@dcs3spp Succesfully merged PR

[dcs3spp]

/release to release-5.3

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@dcs3spp Succesfully merged PR