Skip to content
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
79fc858
Fixes
sharadregoti Nov 3, 2025
6bf9541
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 4, 2025
c9d0cb4
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 6, 2025
4222e6a
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 6, 2025
3aed873
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 7, 2025
86fb7dc
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 11, 2025
1352b96
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 11, 2025
113085e
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 12, 2025
7503180
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 12, 2025
3ea966f
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 14, 2025
a9312cc
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 18, 2025
6f26268
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 18, 2025
c0e4d0b
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 19, 2025
b862450
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 20, 2025
7bd0062
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 21, 2025
3efeafc
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 21, 2025
9ba6c99
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 26, 2025
ac0fa3b
Merge branch 'main' of https://github.com/TykTechnologies/mintlify-poc
sharadregoti Nov 26, 2025
f0ab1df
Fixes
sharadregoti Nov 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions developer-support/release-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,17 @@ Ensure the PRs for documentation, configuration, and release notes have already
1. **Create the New Release Branch**
From the main branch, create a new branch named release-X.Y (e.g., release-5.10). This branch will be used to maintain the documentation for the latest version.

2. **Update the Branch Configuration**
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.
Expand All @@ -150,19 +160,19 @@ Ensure the PRs for documentation, configuration, and release notes have already
}
```

3. **Manually Trigger the Deployment Workflow**
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.

4. **Deploy release:**
5. **Deploy release:**

The PRs mentioned in the prerequisites can now be merged into `main` and the latest release branch.

7. **Update Postman Collections:**\
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.

These instructions are for a single Tyk component and must be repeated for other components.
Expand All @@ -175,13 +185,13 @@ Ensure the PRs for documentation, configuration, and release notes have already

5. Add the `latest` prefix and remove the previous one. This ensures that the latest version is always displayed at the top.

8. **Update the HubSpot Banner to indicate the new release of the old docs pages.**\
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.\
**Example:** [Sample Banner](https://tyk.io/docs/4.0/getting-started/key-concepts/graphql-subscriptions/).

**Steps:** Update the HubSpot banner to indicate the new release.

9. **Add a reference to release notes in Github Releases:**\
8. **Add a reference to release notes in Github Releases:**\
**Description:** Developers usually refer to the GitHub release tags to view the changelog. These release tags should point to the release notes in the docs.\
**Example:** `https://github.com/TykTechnologies/tyk/releases/tag/v5.3.8`\
**Steps:** Modify the release tags of all components modified in a release.\