diff --git a/developer-support/release-guide.mdx b/developer-support/release-guide.mdx index 90a259c3b..a8276dc13 100644 --- a/developer-support/release-guide.mdx +++ b/developer-support/release-guide.mdx @@ -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. @@ -150,7 +160,7 @@ 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. @@ -158,11 +168,11 @@ Ensure the PRs for documentation, configuration, and release notes have already 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. @@ -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.\