[DX-2138] update release docs

[sharadregoti]

PR Type

Documentation

---

Description

• Add docs.json redirects step

• Renumber release workflow steps

• Clarify HubSpot banner step

• Update Postman collections numbering

---

Diagram Walkthrough

flowchart LR
  step1["Create release branch"] -- "prereq" --> step2["Update docs.json redirects"]
  step2 -- "then" --> step3["Update branches-config.json"]
  step3 -- "then" --> step4["Trigger deployment workflow"]
  step4 -- "then" --> step5["Deploy release PRs"]
  step5 -- "then" --> step6["Update Postman collections"]
  step6 -- "then" --> step7["HubSpot banner note"]
  step7 -- "then" --> step8["Link release notes in GitHub Releases"]

Loading

File Walkthrough

	Relevant files
Documentation	release-guide.mdx Release guide adds redirects step and renumbers tasks        developer-support/release-guide.mdx Add new step to update docs.json redirects. Adjust numbering of subsequent steps. Mark HubSpot banner step update with strikethrough emphasis. Minor wording tweaks to deployment and collections steps. +16/-6

---

[github-actions]

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 Formatting The JSON snippet for docs.json shows only a "redirects" array without surrounding braces, which might confuse readers. Consider displaying a minimal valid JSON object or clarifying that only the field is shown. ```json "redirects": [] </details> <details><summary><a href='https://github.com/TykTechnologies/tyk-docs/pull/1036/files#diff-be2219267a40ba39d0fa89e1b9ee9b95243c38dec93711dcef0189f99491854dR135-R176'><strong>Numbering Consistency</strong></a> After inserting the new redirect step, verify all subsequent step numbers and any cross-references remain consistent across the doc (including the Postman and HubSpot sections). </summary> ```txt 2. **Update Redirects in docs.json** - In the `main` branch, edit the `docs.json` file to add all the redirects from the previous latest version. ```json "redirects": [] ``` - In the previous latest branch/version remove all the redirects from `docs.json` as they are no longer needed. 3. **Update the Branch Configuration** In the main branch, edit the `branches-config.json` file. Add a new JSON object for the latest version. This configuration tells the build system how to handle the new version. * Set isLatest to true for the new release-5.10. * Set isLatest to false for the previous latest version (e.g., release-5.9). **Example:** ```json { "branch": "release-5.10", "isLatest": true, "sourceFolder": "5.10-source", "targetFolder": "5.10", "label": "v5.10 (latest)" } ``` 4. **Manually Trigger the Deployment Workflow** 1. Go to the "Actions" tab in the GitHub repository. 2. Select the "Deploy Documentation" workflow. 3. Click "Run workflow" and choose the `production` branch to run it against. This will rebuild the `production` branch, creating the new versioned folder and updating the site's navigation to include v5.10 as the latest version. 5. **Deploy release:** The PRs mentioned in the prerequisites can now be merged into `main` and the latest release branch. 6. **Update Postman Collections:**\ We maintain a Postman collection for the following Tyk Components (Gateway, Dashboard, MDCB, and Developer Portal). After a major or minor release, we need to update the Postman collections. Strikethrough Usage The heading uses "Update" which may render as strikethrough; confirm this is intentional. If not, remove the tildes to avoid confusion. 7. **~~Update~~ the HubSpot Banner to indicate the new release of the old docs pages.**\ **Description:** We use HubSpot to display a banner at the top of our docs page, which indicates that you are viewing old documentation and points to the latest version.\

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Clarify workflow target and prerequisites Specify the exact repository and confirm the target branch input name to prevent running the workflow against the wrong branch/environment. Add a note that the new branch config changes must be merged to main before triggering. developer-support/release-guide.mdx [163-169] 4. **Manually Trigger the Deployment Workflow** - 1. Go to the "Actions" tab in the GitHub repository. - 2. Select the "Deploy Documentation" workflow. - 3. Click "Run workflow" and choose the `production` branch to run it against. + 1. Go to the "Actions" tab in the docs repository. + 2. Select the "Deploy Documentation" workflow. + 3. Click "Run workflow" and select `production` as the target branch/environment. + 4. Ensure all configuration changes (e.g., `branches-config.json`, `docs.json`) are merged into `main` before triggering. Suggestion importance[1-10]: 7 __ Why: Adding that changes must be merged into main before triggering and clarifying the target branch/environment reduces deployment mistakes. It's accurate and context-aware, improving correctness of the process, though not a critical bug fix.	Medium
	Remove ambiguous strikethrough usage Strikethrough in the heading makes the instruction ambiguous (appears as deprecated). If the step is still required, remove strikethrough; if deprecated, explicitly mark it as optional or removed and state why. developer-support/release-guide.mdx [188-193] -7. **~~Update~~ the HubSpot Banner to indicate the new release of the old docs pages.**\ -**Description:** We use HubSpot to display a banner at the top of our docs page, which indicates that you are viewing old documentation and points to the latest version.\ +7. **Update the HubSpot banner for old docs pages.**\ +**Description:** We use HubSpot to display a banner at the top of our docs pages, indicating you are viewing old documentation and linking to the latest version.\ **Example:** [Sample Banner](https://tyk.io/docs/4.0/getting-started/key-concepts/graphql-subscriptions/). Suggestion importance[1-10]: 5 __ Why: The strikethrough on Update implies deprecation and creates ambiguity; removing it or clarifying status improves readability and reduces confusion. This is a valid content/style improvement with moderate impact.	Low
Possible issue	Fix invalid JSON and clarify action The JSON snippet is syntactically invalid and misleading as a standalone value; it should be shown within an object context to avoid copy-paste errors. Also clarify that redirects must be copied from the previous latest into main, not replaced with an empty array. developer-support/release-guide.mdx [135-144] 2. **Update Redirects in docs.json** - - In the `main` branch, edit the `docs.json` file to add all the redirects from the previous latest version. + - In the `main` branch, edit the `docs.json` file to include all redirects from the previous latest version (copy them over, do not clear them). ```json - "redirects": [] + { + "redirects": [ + // ...existing redirects copied from previous latest... + ] + } ``` - - In the previous latest branch/version remove all the redirects from `docs.json` as they are no longer needed. + - In the previous latest branch/version, remove all entries from the `redirects` array (or set it to an empty array) as they are no longer needed there. Suggestion importance[1-10]: 6 __ Why: The existing snippet shows "redirects": [] alone, which is invalid JSON and could mislead users; clarifying to copy redirects into main and showing a proper object is helpful. The change improves accuracy and prevents copy-paste errors but is a documentation clarity fix, not critical.	Low

[buger]

/release to release-5.10

[github-actions]

✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #1038