You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Several placeholders for summaries and descriptions (e.g., release highlights, changelog items) are left incomplete and need to be filled with actual content.
##### Add release highlight summary
Add release highlight description
#### 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.8.0}##### Compatibility Matrix For Tyk Components| Dashboard Version | Recommended Releases | Backwards Compatibility ||---- |---- |---- || 5.8.0 | MDCB v2.7.2 | MDCB v2.5.1 ||| Operator v1.1.0 | Operator v0.17 ||| Sync v2.0.1 | Sync v1.4.3 ||| Helm Chart v2.2 | Helm all versions ||| EDP v1.12 | EDP all versions ||| Pump v1.11.1 | Pump all versions ||| TIB (if using standalone) v1.6.1 | TIB all versions |##### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.8.0}| 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
There are no deprecations in this release.
#### Upgrade instructions {#upgrade-5.8.0}
If you are upgrading to 5.8.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.8.0)-```bash
docker pull tykio/tyk-dashboard:v5.8.0
```
- Helm charts
- [tyk-charts v2.2.0]({{< ref "developer-support/release-notes/helm-chart#220-release-notes">}})
#### Changelog {#Changelog-v5.8.0}##### Added<ul><li><details><summary>Add Changelog item summary</summary>
Add changelog description
</details></li><li><details><summary>Add changelog item summary</summary>
Add changelog description
</details></li></ul>##### Fixed<ul><li><details><summary>Add changelog item summary</summary>
Add changelog description
</details></li><li><details><summary>Add changelog item summary</summary>
Add changelog description
</details>
-#### Release Date xxx+#### Release Date 2025-01-20
Suggestion importance[1-10]: 9
Why: Providing the actual release date is essential for accurate and reliable documentation. This change ensures users have the correct information about the release timeline.
9
Replace placeholder text with actual content
Replace placeholder text such as "Add release highlight summary", "Add release highlight description", and "Add changelog description" with actual content to ensure the release notes are complete and informative for users.
-##### Add release highlight summary+##### Major Performance Improvements-Add release highlight description+This release introduces significant enhancements in API response times and dashboard load speeds, ensuring a smoother user experience.
Suggestion importance[1-10]: 8
Why: Replacing placeholder text with actual content significantly improves the clarity and usefulness of the release notes, making them more informative for users. This is a critical enhancement for documentation quality.
8
Add meaningful changelog summaries and descriptions
Add meaningful summaries and descriptions for the changelog items to clearly communicate the changes and fixes introduced in this release.
<li>
<details>
-<summary>Add Changelog item summary</summary>+<summary>Improved API Gateway Performance</summary>-Add changelog description+Optimized the API Gateway to handle requests more efficiently, reducing latency by 20%.
</details>
</li>
Suggestion importance[1-10]: 8
Why: Adding meaningful summaries and descriptions to the changelog items enhances the documentation by clearly communicating the changes and fixes introduced. This improves user understanding and the overall quality of the release notes.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
DX-1802
Preview Link
Preview
Description
Release note for dashboard
Screenshots (if appropriate)
Checklist
master.PR Type
Documentation
Description
Added release notes for Tyk Dashboard version 5.8.0.
Included compatibility matrix for Tyk components and third-party tools.
Provided upgrade instructions and download links for version 5.8.0.
Added placeholders for changelog items under "Added" and "Fixed" sections.
Changes walkthrough 📝
dashboard.md
Added release notes for Tyk Dashboard 5.8.0tyk-docs/content/developer-support/release-notes/dashboard.md
tools.
sections.