Skip to content

docs: Tyk Operator 1.4.0 release notes#1826

Open
JoanCamosTyk wants to merge 4 commits intomainfrom
JoanCamosTyk-patch-37
Open

docs: Tyk Operator 1.4.0 release notes#1826
JoanCamosTyk wants to merge 4 commits intomainfrom
JoanCamosTyk-patch-37

Conversation

@JoanCamosTyk
Copy link
Copy Markdown
Contributor

@JoanCamosTyk JoanCamosTyk commented Apr 2, 2026

PR Type

Documentation


Description

  • Add Operator 1.4.0 release notes

  • Document install bug and Helm requirement

  • Add dependencies, upgrades, downloads sections

  • Fix 1.3.0 Helm chart anchor link


Diagram Walkthrough

flowchart LR
  rn14["Operator 1.4.0 release notes"]
  bugnote["Installation bug note"]
  helmreq["Use tyk-charts 5.2.0+"]
  meta["Dependencies, upgrades, downloads"]
  fix13["Correct 1.3.0 Helm link"]
  rn14 -- "includes" --> bugnote
  bugnote -- "requires" --> helmreq
  rn14 -- "adds" --> meta
  rn14 -- "also" --> fix13
Loading

File Walkthrough

Relevant files
Documentation
operator.mdx
Add Operator 1.4.0 release notes section                                 

developer-support/release-notes/operator.mdx

  • Add a new 1.4.0 release notes section
  • Document an initial Helm chart installation bug
  • Add dependency, upgrade, download, and changelog placeholders
  • Fix the 1.3.0 Helm chart release-notes anchor
+60/-1   

@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 2, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tyk 🟢 Ready View Preview Apr 2, 2026, 9:19 AM

@JoanCamosTyk JoanCamosTyk marked this pull request as draft April 2, 2026 09:14
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Broken link

The installation note links to the Helm 5.2.0 release notes using a different anchor format than the downloads section. If the site uses the same slugging pattern as the adjacent #520-release-notes link, this note will send readers to a missing anchor exactly when they follow the install workaround.

The initial `Helm chart` for Operator 1.4.0 contained an installation bug. Please ensure you use tyk-charts version [5.2.0](/developer-support/release-notes/helm-chart#5-2-0-release-notes) or later to install Operator 1.4.0.
Placeholder date

The 1.4.0 release date still contains xx instead of a real day. This will ship unfinished release notes and leaves the published release date ambiguous for readers.

#### Release Date xx April 2026
Wrong year

The overview metadata for Operator 1.4.0 still lists the release date as 2025, while the new release notes are for 2026. Any page consuming this metadata will show the wrong release year for the latest Operator version.

"date": "01/04/2025",

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Correct latest release date

The latestData.date for the new 1.4.0 Operator release still points to 2025, which
makes the release metadata inconsistent with the new release notes section. Update
it to the correct 2026 date so sorting and displayed release information stay
accurate.

developer-support/release-notes/overview.mdx [30]

-"date": "01/04/2025",
+"date": "01/04/2026",
Suggestion importance[1-10]: 7

__

Why: The new 1.4.0 entry in releaseData still uses 2025, which conflicts with the newly added 1.4 release notes and would show incorrect release metadata. This is a small change, but it meaningfully improves correctness for displayed and potentially sorted release information.

Medium
Fix Docker tag URL

The Docker tag URL drops the v prefix even though the release notes and image tag
use v1.4.0. This can send users to the wrong tag filter or an empty result, so keep
the URL aligned with the published image tag.

developer-support/release-notes/overview.mdx [31]

-"docker": "https://hub.docker.com/r/tykio/tyk-operator/tags?page=1&name=1.4.0"
+"docker": "https://hub.docker.com/r/tykio/tyk-operator/tags?page=1&name=v1.4.0"
Suggestion importance[1-10]: 6

__

Why: The docker URL for the Operator release omits the v prefix even though the PR consistently refers to the image tag as v1.4.0. Aligning the URL with the published tag helps avoid broken or misleading Docker Hub filtering.

Low
Align Helm anchor link

The anchor in this Helm chart link does not match the anchor format used elsewhere
in this PR for 5.2.0. Use the same fragment consistently, otherwise this warning
note may link to a missing section.

developer-support/release-notes/operator.mdx [30]

-The initial `Helm chart` for Operator 1.4.0 contained an installation bug. Please ensure you use tyk-charts version [5.2.0](/developer-support/release-notes/helm-chart#5-2-0-release-notes) or later to install Operator 1.4.0.
+The initial `Helm chart` for Operator 1.4.0 contained an installation bug. Please ensure you use tyk-charts version [5.2.0](/developer-support/release-notes/helm-chart#520-release-notes) or later to install Operator 1.4.0.
Suggestion importance[1-10]: 5

__

Why: The note links to #5-2-0-release-notes, while the Downloads section in the same PR uses #520-release-notes for 5.2.0. Using a consistent fragment is a reasonable fix because the current mismatch may send readers to a missing anchor.

Low

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.

3 participants