From 2ecf5c27c517de1fed34767ef2bcb0ca86394e34 Mon Sep 17 00:00:00 2001
From: elizabeth opayemi <Elizabeth@tyk.io>
Date: Thu, 17 Oct 2024 13:34:28 +0100
Subject: [PATCH] 5.7.0

---
 .../release-notes/version-5.7.md              | 217 ++++++++++++++++++
 tyk-docs/data/menu.yaml                       |   4 +
 2 files changed, 221 insertions(+)
 create mode 100644 tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.7.md

diff --git a/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.7.md b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.7.md
new file mode 100644
index 0000000000..4e86378dd0
--- /dev/null
+++ b/tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.7.md
@@ -0,0 +1,217 @@
+---
+title: Tyk Dashboard 5.7 Release Notes
+date: 2024-10-08T15:51:11Z
+description: "Release notes documenting updates, enhancements, and changes for Tyk Dashboard versions within the 5.6.X series."
+tags: ["Tyk Dashboard", "Release notes", "v5.7", "5.7.0", "5.7", "changelog"]
+---
+<!-- Required. oss or licensed. Choose one of the following:
+    **Licensed Protected Product**
+    Or
+    ****Open Source** ([Mozilla Public License](https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md))**
+-->
+
+**This page contains all release notes for version 5.7.X displayed in a reverse chronological order**
+
+## Support Lifetime
+
+Our minor releases are supported until our next minor comes out.
+
+---
+## 5.7.0 Release Notes
+
+### Release Date xxx
+
+### Release Highlights
+<!-- Required. Use similar ToV to previous release notes. For example for a patch release:
+This release primarily focuses on bug fixes.
+For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-vX.Y.0">}}) below.
+-->
+We are thrilled to announce new updates and improvements in Tyk 5.7.0, bringing more control, flexibility, and performance.  For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.7.0">}}) below.
+
+#### Add release highlight summary
+
+Add release highlight summary
+
+#### Add release highlight summary
+
+Add release highlight summary
+
+### Breaking Changes
+<!-- Required. Use the following statement if there are no breaking changes, or explain if there are -->
+
+There are no breaking changes in this release.
+
+### Dependencies {#dependencies-5.7.0}
+<!--Required. Use this section to announce the following types of dependencies compatible with the release:
+Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
+3rd party dependencies and tools -->
+#### Compatibility Matrix For Tyk Components
+<!-- Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
+An illustrative example is shown below. -->
+| Dashboard Version | Recommended Releases | Backwards Compatibility |
+|----    |---- |---- |
+| 5.7.0 | MDCB v2.7.1     | MDCB v2.5.1 |
+|         | Operator v1.0.0  | Operator v0.17 |
+|         | Sync v2.0    | Sync v1.4.3 |
+|         | Helm Chart v2.1  | Helm all versions |
+| | EDP v1.11 | EDP all versions |
+| | Pump v1.11 | Pump all versions |
+| | TIB (if using standalone) v1.5.1 | TIB all versions |
+
+#### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.7.0}
+<!-- Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
+
+Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
+
+An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. -->
+
+| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
+| ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- | 
+| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 | 
+| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Dashboard | 
+| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | Used by Tyk Dashboard | 
+| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x LTS        | 12.x - 16.x            | Used by Tyk Dashboard | 
+| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS]({{< ref "tyk-apis/tyk-gateway-api/oas/x-tyk-oas-doc" >}})|
+
+### Deprecations
+<!-- Required. Use the following statement if there are no deprecations, or explain if there are -->
+There are no deprecations in this release.
+<!-- Optional section!
+Used to share and notify users about our plan to deprecate features, configs etc.
+Once you put an item in this section, we must keep this item listed in all the following releases till the deprecation happens. -->
+<!-- ##### Future deprecations
+-->
+### Upgrade instructions {#upgrade-5.7.0}
+If you are upgrading to 5.7.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 
+
+### Downloads
+- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.7.0)
+- ```bash
+  docker pull tykio/tyk-dashboard:v5.7.0
+  ```
+- Helm charts
+  - [tyk-charts v2.1.0]({{<ref "product-stack/tyk-charts/release-notes/version-2.1.md">}})
+
+### Changelog {#Changelog-v5.7.0}
+<!-- Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
+Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
+"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
+"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" -->
+#### Added
+<!-- This section should be a bullet point list of new features. Explain:
+- The purpose of the new feature
+- How does the new feature benefit users?
+- Link to documentation of the new feature
+- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
+Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
+<ul>
+<li>
+<details>
+<summary>Add changelog summary</summary>
+
+Add changelog description
+</details>
+</li>
+</ul>
+
+#### Changed
+
+<!-- This should be a bullet-point list of updated features. Explain:
+
+- Why was the update necessary?
+- How does the update benefit users?
+- Link to documentation of the updated feature
+- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
+
+Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
+<ul>
+<li>
+<details>
+<summary>Add changelog summary</summary>
+
+Add changelog summary
+</details>
+</li>
+<li>
+<details>
+<summary>Add changelog summary</summary>
+
+Add changelog summary
+</details>
+</li>
+</ul>
+
+#### Fixed
+<!-- This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
+- What problem the issue caused
+- How was the issue fixed
+- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
+- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
+Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
+<ul>
+<li>
+<details>
+<summary>Add changelog summary</summary>
+
+Add changelog description
+</details>
+</li>
+<li>
+<details>
+<summary>Add changelog summary</summary>
+
+Add changelog description
+</details>
+</li>
+</ul>
+
+#### Security Fixes
+<!-- This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
+1. Dependency-tracked CVEs - External-tracked CVEs should be included on the release note.
+2. Internal scanned CVEs - Refer to the relevant engineering and delivery policy.
+For agreed CVE security fixes, provide a link to the corresponding entry on the NIST website. For example:
+- Fixed the following CVEs:
+    - [CVE-2022-33082](https://nvd.nist.gov/vuln/detail/CVE-2022-33082)
+-->
+<ul>
+<li>
+<details>
+<summary>Add priority CVEs fixed</summary>
+
+Add CVE summary
+</details>
+</li>
+</ul>
+
+<!-- Required. use 3 hyphens --- between release notes of every patch (minors will be on a separate page) -->
+
+---
+
+<!--
+Repeat the release notes section above for every patch here
+-->
+<!-- The footer of the release notes page. It contains a further information section with details of how to upgrade Tyk,
+links to API documentation and FAQs. You can copy it from the previous release. -->
+
+## Further Information
+
+### Upgrading Tyk
+Please refer to the [upgrading Tyk]({{< ref "upgrading-tyk" >}}) page for further guidance on the upgrade strategy.
+
+### API Documentation
+<!-- Required. Update the link to the Gateway "tyk-gateway-api" or dashboard "tyk-dashboard-api" and the Postman collection
+
+If there were changes in any of Tyk’s API docs:
+
+- Have API endpoints been documented in the release note summary and changelog?				
+- Has a link to the endpoint documentation being included?
+- Has the benefit of the new/updated endpoint been explained in the release highlights and changelog?
+-->
+- [OpenAPI Document]({{<ref "tyk-dashboard-api/" >}})
+- [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/overview)
+
+### FAQ
+
+Please visit our [Developer Support]({{< ref "frequently-asked-questions/faq" >}}) page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.
+
+
diff --git a/tyk-docs/data/menu.yaml b/tyk-docs/data/menu.yaml
index bc72b70a57..55c47419d5 100644
--- a/tyk-docs/data/menu.yaml
+++ b/tyk-docs/data/menu.yaml
@@ -2927,6 +2927,10 @@ menu:
                 category: Page
                 path: /product-stack/tyk-dashboard/release-notes/overview
                 show: True
+              - title: "Tyk Dashboard v5.7"
+                path: /product-stack/tyk-dashboard/release-notes/version-5.7
+                category: Page
+                show: True
               - title: "Tyk Dashboard v5.6"
                 path: /product-stack/tyk-dashboard/release-notes/version-5.6
                 category: Page