Improve messaging about supported releases

[letzya]

User description

Preview Link

Checklist

• Added a preview link
• Reviewed AI PR Agent suggestions
• For Tyk Members - Added Jira DX PR ticket to the subject
• For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors

• Make sure you have started your change off our latest master.
• I have reviewed the guidelines for contributing to this repository.
• I have read the technical guidelines for contributing to this repository.

---

PR Type

Documentation

---

Description

• Clarify support lifetime messaging

• Add LTS and non-LTS guidance snippet

• Anchor upgrade and API docs headings

---

Diagram Walkthrough

flowchart LR
  Template["Release notes condensed template"] -- "Replace support text" --> SupportMsg["Guidance for LTS/non-LTS"]
  Template -- "Add anchors" --> Anchors["Anchors for headings"]

Loading

File Walkthrough

	Relevant files
Documentation	release-notes-condensed-template.md Support messaging update and heading anchors                          tyk-docs/assets/others/release-notes-condensed-template.md Replace support lifetime text with guidance block for LTS/non-LTS. Include links to LTS policy and current timeline. Add anchor IDs to "Upgrading Tyk" and "API Documentation" headings. +16/-3

---

[github-actions]

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

[github-actions]

PR Reviewer Guide 🔍

(Review updated until commit eb09f01)

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 Anchor The custom heading anchors use the syntax {#id} which may not be recognized by Hugo by default; Hugo typically uses auto-generated IDs or requires a shortcode/Goldmark config. Verify that these anchors render and link correctly on the site. ### Upgrading Tyk {#upgrading-tyk} Please refer to the [upgrading Tyk]({{< ref "developer-support/upgrading" >}}) page for further guidance on the upgrade strategy. ### API Documentation {#api-documentation} - [OpenAPI Document]({{< ref "" >}}) Placeholder Links The API documentation links still contain placeholders (e.g., empty ref for OpenAPI and <collection-id>). Ensure templates include clear instructions or fail-safe text so users don't publish with placeholders. - [OpenAPI Document]({{< ref "" >}}) - [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/collection/<collection-id>) Commented Guidance Visibility The LTS/non-LTS guidance is inside an HTML comment; confirm editors know to replace it with one of the messages, or consider using a visible TODO or shortcode to reduce risk of shipping empty Support Lifetime sections. <!-- Please add one of the following statements to the release notes you are preparing: For non-LTS releases: ---------------------- **This version supersedes all previous non-LTS releases, which are no longer maintained.** The [current LTS release](https://tyk.io/docs/developer-support/release-types/long-term-support/#current-lts-releases-timeline) continues to receive maintenance alongside this version. For details on our release lifecycle and maintenance policies, see the [release support documentation](https://tyk.io/docs/developer-support/release-types/long-term-support/). For LTS releases: ------------------ This is an **LTS release**, maintained under our [Long Term Support policy](https://tyk.io/docs/developer-support/release-types/long-term-support/). For maintained LTS versions, check the [current LTS releases timeline](https://tyk.io/docs/developer-support/release-types/long-term-support/#current-lts-releases-timeline). -->

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Prevent publishing broken links The placeholder ref and collection ID will render as broken links in published docs. Add explicit TODO markers to prevent accidental publication with invalid URLs and remove the brittle manual anchor. tyk-docs/assets/others/release-notes-condensed-template.md [172-174] -### API Documentation {#api-documentation} -- [OpenAPI Document]({{< ref "" >}}) -- [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/collection/<collection-id>) +### API Documentation +- [OpenAPI Document]({{< ref "REPLACE_WITH_DOC_PATH" >}}) <!-- TODO: set correct doc path --> +- [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/collection/REPLACE_WITH_COLLECTION_ID) <!-- TODO: set correct collection ID --> Suggestion importance[1-10]: 6 __ Why: Replacing placeholder refs with explicit TODOs helps avoid publishing broken links and removing the manual anchor is reasonable. The improved_code reflects the intent and is a practical safeguard, though not critical.	Low
General	Make support guidance visible The guidance is hidden in an HTML comment, which risks being omitted when copying the template, leading to missing support statements in published notes. Surface a visible placeholder with clear TODO markers to ensure editors replace it, while keeping the detailed instructions in the comment. tyk-docs/assets/others/release-notes-condensed-template.md [11-24] <!-- Please add one of the following statements to the release notes you are preparing: For non-LTS releases: ---------------------- **This version supersedes all previous non-LTS releases, which are no longer maintained.** The [current LTS release](https://tyk.io/docs/developer-support/release-types/long-term-support/#current-lts-releases-timeline) continues to receive maintenance alongside this version. For details on our release lifecycle and maintenance policies, see the [release support documentation](https://tyk.io/docs/developer-support/release-types/long-term-support/). For LTS releases: ------------------ This is an **LTS release**, maintained under our [Long Term Support policy](https://tyk.io/docs/developer-support/release-types/long-term-support/). For maintained LTS versions, check the [current LTS releases timeline](https://tyk.io/docs/developer-support/release-types/long-term-support/#current-lts-releases-timeline). --> +> TODO: Replace this section with the appropriate support statement (non-LTS or LTS) before publishing. See the guidance above. + Suggestion importance[1-10]: 5 __ Why: The existing guidance is inside an HTML comment (lines 11-24); making a visible TODO could reduce omission risk, but it's an editorial choice and not required by the PR. The improved_code accurately adds a visible reminder without altering the commented instructions.	Low
	Avoid brittle manual header IDs The manual anchor may duplicate auto-generated IDs and cause broken links if the header text changes. Prefer Hugo's auto IDs or ensure the custom ID matches cross-references; if keeping it, update internal links accordingly. tyk-docs/assets/others/release-notes-condensed-template.md [169-170] -### Upgrading Tyk {#upgrading-tyk} +### Upgrading Tyk Please refer to the [upgrading Tyk]({{< ref "developer-support/upgrading" >}}) page for further guidance on the upgrade strategy. Suggestion importance[1-10]: 4 __ Why: Removing the manual anchor from ### Upgrading Tyk {#upgrading-tyk} may reduce brittleness, but it could also break existing cross-references. It's a minor improvement and context-dependent; the improved_code matches the proposed change.	Low

[netlify]

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

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

[netlify]

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

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

[letzya]

/writer please review the change

[tykbot]

PR Review: Improve messaging about supported releases

I've reviewed the changes to the release-notes-condensed-template.md file, which enhances the "Support Lifetime" section of the release notes template.

Changes Overview

The PR updates the template by adding detailed HTML comments with specific messaging templates for both LTS and non-LTS releases. These comments provide clear guidance to release note authors without affecting the final published content.

Key Improvements

1. Clear Differentiation: The template now clearly distinguishes between LTS and non-LTS releases, providing appropriate messaging for each type.

2. Comprehensive Information: For non-LTS releases, the template explains that they supersede previous non-LTS releases while noting that the current LTS release remains supported alongside.

3. Documentation Links: Both templates include direct links to:

   • The current LTS releases timeline
   • The Long Term Support policy
   • General release support documentation

4. Author Guidance: The HTML comment format provides clear instructions to release note authors without cluttering the final published document.

Recommendation

This change significantly improves the clarity and consistency of release support messaging in the documentation. The templates are well-structured, provide appropriate links to relevant documentation, and offer clear guidance to authors.

The PR successfully addresses its stated goal of improving messaging about supported releases and should be approved.

---

Tip: Mention me again using /writer <request>.
Powered by Probe AI

[letzya]

@allaneyles can you please review this messaging (based on customer's misunderstanding). Thanks