Skip to content

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Sep 10, 2025

User description

Contributor checklist

  • Reviewed PR Code suggestions and updated accordingly
  • Tyklings: Labled the PR with the relevant releases
  • Tyklings: Added Jira DX PR ticket to the subject

New Contributors



PR Type

Documentation


Description

  • Add Dashboard 5.10 release notes scaffold

  • Document dependencies and compatibility matrix

  • Provide downloads and upgrade sections

  • Add 3rd-party tools versions table


Diagram Walkthrough

flowchart LR
  notes["Add 5.10 release notes"] -- "includes" --> deps["Dependencies matrix"]
  notes -- "includes" --> tools["3rd-party tools versions"]
  notes -- "includes" --> upgrade["Upgrade instructions"]
  notes -- "includes" --> downloads["Downloads (Docker/Helm)"]
  notes -- "includes" --> changelog["Changelog placeholder"]
Loading

File Walkthrough

Relevant files
Documentation
dashboard.md
Introduce Dashboard 5.10.0 release notes                                 

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

  • Add 5.10 release notes section and highlights.
  • Include dependencies and 3rd-party tools tables.
  • Add upgrade instructions and downloads links.
  • Insert changelog placeholder for fixes.
+67/-0   

Copy link
Contributor

⚠️ Deploy preview for PR #6921 did not become live after 3 attempts.
Please check Netlify or try manually: Preview URL

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

Placeholder Dates

The release date is marked as 'xx 2025'; confirm and replace with the exact release date before publishing.

#### Release Date xx 2025
Compatibility Table Accuracy

The dependencies matrix lists specific versions (e.g., Go 1.24, Helm v3.1.0, Operator v1.2.0) and broad compatibility claims; validate these against actual tested/supported versions to avoid misleading guidance.

#### Dependencies {#dependencies-5.10.0}

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 5.10.0  | MDCB v2.8.4       | MDCB v2.8.4 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.3       | Sync v2.1.0 |
|        | Helm Chart v3.1.0 | Helm all versions |
|        | EDP v1.14.1       | EDP all versions |
|        | Pump v1.12.1      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.10.0}

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
Incomplete Changelog

The changelog 'Fixed' section is an empty scaffold; ensure actual entries are added or remove the section until content is ready.

#### Changelog {#Changelog-v5.10.0}

##### Fixed

<ul>
<li>
<details>
<summary></summary>

</details>
</li>
</ul>

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix malformed table rows

The first column is blank for all but the first row, which may break table parsing
and screen-reader clarity. Repeat the 5.10.0 version in each row for consistency and
accessibility.

tyk-docs/content/developer-support/release-notes/dashboard.md [52-61]

 | Dashboard Version | Recommended Releases | Backwards Compatibility |
-|--------|-------------------|-------------|
-| 5.10.0  | MDCB v2.8.4       | MDCB v2.8.4 |
-|        | Operator v1.2.0   | Operator v0.17 |
-|        | Sync v2.1.3       | Sync v2.1.0 |
-|        | Helm Chart v3.1.0 | Helm all versions |
-|        | EDP v1.14.1       | EDP all versions |
-|        | Pump v1.12.1      | Pump all versions |
-|        | TIB (if using standalone) v1.7.0 | TIB all versions |
+|-------------------|----------------------|-------------------------|
+| 5.10.0            | MDCB v2.8.4          | MDCB v2.8.4            |
+| 5.10.0            | Operator v1.2.0      | Operator v0.17         |
+| 5.10.0            | Sync v2.1.3          | Sync v2.1.0            |
+| 5.10.0            | Helm Chart v3.1.0    | Helm all versions      |
+| 5.10.0            | EDP v1.14.1          | EDP all versions       |
+| 5.10.0            | Pump v1.12.1         | Pump all versions      |
+| 5.10.0            | TIB (if using standalone) v1.7.0 | TIB all versions |
Suggestion importance[1-10]: 7

__

Why: Repeating 5.10.0 improves table accessibility and parsing consistency; the change matches the existing lines and enhances readability without altering meaning.

Medium
Possible issue
Fix in-page anchor link

The self-ref link should use a valid in-page anchor without Hugo ref to avoid broken
links. Replace the Hugo ref with a direct anchor link matching the section id.

tyk-docs/content/developer-support/release-notes/dashboard.md [44]

-For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.10.0" >}}).
+For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.10.0).
Suggestion importance[1-10]: 6

__

Why: Using a direct in-page anchor (#Changelog-v5.10.0) is safer than {{< ref "#..." >}} for self-links and prevents potential build-time link issues; reasonable impact on docs correctness.

Low
Replace placeholder date

Replace the placeholder release date with the actual date to avoid publishing
incomplete information. If the exact date is not finalized, clearly mark it as TBC
with a note to update before release.

tyk-docs/content/developer-support/release-notes/dashboard.md [40]

-#### Release Date xx 2025
+#### Release Date 2025-09-10
Suggestion importance[1-10]: 5

__

Why: Replacing the placeholder xx 2025 with an actual date avoids publishing incomplete info; it's correct but routine and content-oriented rather than code-critical.

Low

Copy link

netlify bot commented Sep 10, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit 58c335e
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68e6051f434fa30008abb076
😎 Deploy Preview https://deploy-preview-6921--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 project configuration.

@sharadregoti
Copy link
Contributor

/probe "Based on the newly added features in the gateway & dashboard. Can you create a list of tasks for which documentation has to be created?"

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.

4 participants