chore(docs): update optimize update guides to use correct version (#2512

) * chore(docs): update optimize update guides to use correct version * Update optimize/self-managed/optimize-deployment/migration-update/3.10-to-3.11.md * more updates for 7.20_8.3 * update update chart * review fixes * replace last 3.11 to 7.20/8.3 --------- Co-authored-by: Amara Graham <[email protected]> Co-authored-by: Amara <[email protected]> Co-authored-by: misiekhardcore <[email protected]> Co-authored-by: Michał Konopski <[email protected]>
camunda · Sep 7, 2023 · 339abe4 · 339abe4
1 parent 69dc6c4
commit 339abe4
Show file tree

Hide file tree

Showing 11 changed files with 47 additions and 44 deletions.
diff --git a/docs/reference/supported-environments.md b/docs/reference/supported-environments.md
@@ -78,17 +78,17 @@ You can also use newer versions of Desktop and Web Modeler with older Zeebe vers
 
 ## Camunda Platform 7 & Optimize version matrix
 
-| Improve         | Automate                                   | Java version              | Elasticsearch version                                                         |
-| --------------- | ------------------------------------------ | ------------------------- | ----------------------------------------------------------------------------- |
-| Optimize 3.3.x  | Camunda Platform 7.12.11+, 7.13.5+, 7.14.x | OpenJDK 8+ or OpenJDK 11+ | 7.3.0+, 7.4.0+, 7.5.0+, 7.6.0+, 7.7.0+, 7.8.0+, 7.9.0+, 7.10.0+               |
-| Optimize 3.4.x  | Camunda Platform 7.13.5+, 7.14.x, 7.15.x   | OpenJDK 8+ or OpenJDK 11+ | 7.5.1+, 7.6.0+, 7.7.0+, 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+                      |
-| Optimize 3.5.x  | Camunda Platform 7.13.5+, 7.14.x, 7.15.x   | OpenJDK 11+               | 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+                            |
-| Optimize 3.6.x  | Camunda Platform 7.14.x, 7.15.x, 7.16.x    | OpenJDK 11+               | 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+          |
-| Optimize 3.7.x  | Camunda Platform 7.14.x, 7.15.x, 7.16.x    | OpenJDK 11+               | 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+ |
-| Optimize 3.8.x  | Camunda Platform 7.15.x, 7.16.x, 7.17.x    | OpenJDK 11+               | 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+, 7.17.0+        |
-| Optimize 3.9.x  | Camunda Platform 7.16.x, 7.17.x, 7.18.x    | OpenJDK 11+               | 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+, 7.17.0+                                   |
-| Optimize 3.10.x | Camunda Platform 7.17.x, 7.18.x, 7.19.x    | OpenJDK 17+               | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+                                              |
-| Optimize 3.11.x | Camunda Platform 7.17.x, 7.18.x, 7.19.x    | OpenJDK 17+               | 8.7.0+, 8.8.0+                                                                |
+| Improve         | Automate                                        | Java version              | Elasticsearch version                                                         |
+| --------------- | ----------------------------------------------- | ------------------------- | ----------------------------------------------------------------------------- |
+| Optimize 3.3.x  | Camunda Platform 7.12.11+, 7.13.5+, 7.14.x      | OpenJDK 8+ or OpenJDK 11+ | 7.3.0+, 7.4.0+, 7.5.0+, 7.6.0+, 7.7.0+, 7.8.0+, 7.9.0+, 7.10.0+               |
+| Optimize 3.4.x  | Camunda Platform 7.13.5+, 7.14.x, 7.15.x        | OpenJDK 8+ or OpenJDK 11+ | 7.5.1+, 7.6.0+, 7.7.0+, 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+                      |
+| Optimize 3.5.x  | Camunda Platform 7.13.5+, 7.14.x, 7.15.x        | OpenJDK 11+               | 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+                            |
+| Optimize 3.6.x  | Camunda Platform 7.14.x, 7.15.x, 7.16.x         | OpenJDK 11+               | 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+          |
+| Optimize 3.7.x  | Camunda Platform 7.14.x, 7.15.x, 7.16.x         | OpenJDK 11+               | 7.8.0+, 7.9.0+, 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+ |
+| Optimize 3.8.x  | Camunda Platform 7.15.x, 7.16.x, 7.17.x         | OpenJDK 11+               | 7.10.0+, 7.11.0+, 7.12.0+, 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+, 7.17.0+        |
+| Optimize 3.9.x  | Camunda Platform 7.16.x, 7.17.x, 7.18.x         | OpenJDK 11+               | 7.13.0+, 7.14.0+, 7.15.0+, 7.16.2+, 7.17.0+                                   |
+| Optimize 3.10.x | Camunda Platform 7.17.x, 7.18.x, 7.19.x         | OpenJDK 17+               | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+                                              |
+| Optimize 8.3.x  | Camunda Platform 7.17.x, 7.18.x, 7.19.x, 7.20.x | OpenJDK 17+               | 8.7.0+, 8.8.0+                                                                |
 
 :::note Elasticsearch support
 [Elastic's Elasticsearch](https://www.elastic.co/elasticsearch/) is the only supported version of Elastic compatible with Optimize.

diff --git a/...ployment/migration-update/3.10-to-3.11.md → ...ment/migration-update/3.10-to-7.20_8.3.md b/...ployment/migration-update/3.10-to-3.11.md → ...ment/migration-update/3.10-to-7.20_8.3.md
@@ -1,13 +1,13 @@
 ---
-id: 3.10-to-3.11
-title: "Update notes (3.10-to-3.11)"
+id: 3.10-to-7.20_8.3
+title: "Update notes (3.10 to 7.20/8.3)"
 ---
 
 :::note Heads up!
-To update Optimize to version 3.11, perform the steps in the [migration and update instructions](./instructions.md).
+To update Optimize to version 7.20/8.3, perform the steps in the [migration and update instructions](./instructions.md).
 :::
 
-The update to 3.11 can be performed from any 3.10.x release.
+The update to 7.20/8.3 can be performed from any 3.10.x release.
 
 Here you will find information about:
 
@@ -21,15 +21,15 @@ Here you will find information about:
 
 ### Elasticsearch
 
-With 3.11, Optimize now supports Elasticsearch `8.7` and `8.8`. Elasticsearch `8.5` and `8.6` are no longer supported.
+With 7.20/8.3, Optimize now supports Elasticsearch `8.7` and `8.8`. Elasticsearch `8.5` and `8.6` are no longer supported.
 Additionally, please note there are temporary changes in Optimize's Elasticsearch support as detailed below:
 
-| Optimize version                  | Elasticsearch version            |
-| --------------------------------- | -------------------------------- |
-| Optimize 3.10.0 - Optimize 3.10.3 | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
-| Optimize 3.10.4                   | 7.16.2+, 7.17.0+, 8.7.0+, 8.8.0+ |
-| Optimize 3.10.5 - Optimize 3.11.x | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
-| Optimize 3.11.x                   | 8.7.0+, 8.8.0+                   |
+| Optimize version                        | Elasticsearch version            |
+| --------------------------------------- | -------------------------------- |
+| Optimize 3.10.0 - Optimize 3.10.3       | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
+| Optimize 3.10.4                         | 7.16.2+, 7.17.0+, 8.7.0+, 8.8.0+ |
+| Optimize 3.10.5 - Optimize 7.20.x/8.3.x | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
+| Optimize 7.20.x/8.3.x                   | 8.7.0+, 8.8.0+                   |
 
 See the [supported environments]($docs$/reference/supported-environments) section for the full range of supported versions.
 
@@ -51,13 +51,13 @@ With the change to Spring Boot 3, Optimize's logging configuration format has al
 
 ### Collection Role Cleanup
 
-Prior to Optimize 3.11.0, Optimize has performed collection role cleanup after syncing identities with the engine. From
-Optimize 3.11.0 onwards, this is now disabled by default. It can be reenabled by setting the
+Prior to Optimize 7.20/8.3, Optimize has performed collection role cleanup after syncing identities with the engine. From
+Optimize 7.20/8.3 onwards, this is now disabled by default. It can be reenabled by setting the
 `import.identitySync.collectionRoleCleanupEnabled` property value to `true`
 
 ### API behavior
 
-Before the 3.11.0 release, the Optimize API would accept requests when the URI contained a trailing slash (`/`). This is no longer the case, and requests containing a trailing slash will no longer be matched to the corresponding API path.
+Before the 7.20/8.3 release, the Optimize API would accept requests when the URI contained a trailing slash (`/`). This is no longer the case, and requests containing a trailing slash will no longer be matched to the corresponding API path.
 
 ### Raw Data Report API
 

diff --git a/optimize/self-managed/optimize-deployment/migration-update/3.9-to-3.10.md b/optimize/self-managed/optimize-deployment/migration-update/3.9-to-3.10.md
@@ -24,11 +24,11 @@ Here you will find information about:
 Optimize now supports Elasticsearch `8.5` and `8.6`, but it requires at least Elasticsearch `7.16.2`.
 Additionally, when updating to Optimize 3.10.x please note there are temporary changes in Optimize's Elasticsearch support as detailed below:
 
-| Optimize version                  | Elasticsearch version            |
-| --------------------------------- | -------------------------------- |
-| Optimize 3.10.0 - Optimize 3.10.3 | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
-| Optimize 3.10.4                   | 7.16.2+, 7.17.0+, 8.7.0+, 8.8.0+ |
-| Optimize 3.10.5 - Optimize 3.11.x | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
+| Optimize version                        | Elasticsearch version            |
+| --------------------------------------- | -------------------------------- |
+| Optimize 3.10.0 - Optimize 3.10.3       | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
+| Optimize 3.10.4                         | 7.16.2+, 7.17.0+, 8.7.0+, 8.8.0+ |
+| Optimize 3.10.5 - Optimize 7.20.x/8.3.x | 7.16.2+, 7.17.0+, 8.5.0+, 8.6.0+ |
 
 See the [supported environments]($docs$/reference/supported-environments) section for the full range of supported versions.
 

diff --git a/optimize/self-managed/optimize-deployment/migration-update/instructions.md b/optimize/self-managed/optimize-deployment/migration-update/instructions.md
@@ -4,16 +4,16 @@ title: "Instructions"
 description: "Find out how to update to a new version of Optimize without losing your reports and dashboards."
 ---
 
-Roughly every quarter of a year a new minor version of Optimize is released. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
+Optimize releases two new minor versions a year. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
 
 If you want to update Optimize by several versions, you cannot do that at once, but you need to perform the updates in sequential order. For instance, if you want to update from 2.5 to 3.0, you need to update first from 2.5 to 2.6, then from 2.6 to 2.7, and finally from 2.7 to 3.0. The following table shows the recommended update paths to the latest version:
 
-| Update from | Recommended update path to 3.10                                   |
-| ----------- | ----------------------------------------------------------------- |
-| 3.10        | You are on the latest version.                                    |
-| 3.0 - 3.9.x | Rolling update to 3.10                                            |
-| 2.0 - 2.7   | 1. Rolling update to 2.7 <br /> 2. Rolling update from 2.7 to 3.0 |
-| 1.0 - 1.5   | No update possible. Use the latest version directly.              |
+| Update from  | Recommended update path to 7.20/8.3                               |
+| ------------ | ----------------------------------------------------------------- |
+| 7.20/8.3     | You are on the latest version.                                    |
+| 3.0 - 3.10.x | Rolling update to 7.20/8.3                                        |
+| 2.0 - 2.7    | 1. Rolling update to 2.7 <br /> 2. Rolling update from 2.7 to 3.0 |
+| 1.0 - 1.5    | No update possible. Use the latest version directly.              |
 
 ## Migration instructions
 

diff --git a/optimize_sidebars.js b/optimize_sidebars.js
@@ -1892,7 +1892,7 @@ module.exports = {
         {
           "Migration & update": [
             "self-managed/optimize-deployment/migration-update/instructions",
-            "self-managed/optimize-deployment/migration-update/3.10-to-3.11",
+            "self-managed/optimize-deployment/migration-update/3.10-to-7.20_8.3",
             "self-managed/optimize-deployment/migration-update/3.9-to-3.10",
             "self-managed/optimize-deployment/migration-update/3.9-preview-1-to-3.9",
             "self-managed/optimize-deployment/migration-update/3.8-to-3.9-preview-1",

diff --git a/...ersion-3.10.0/self-managed/optimize-deployment/migration-update/instructions.md b/...ersion-3.10.0/self-managed/optimize-deployment/migration-update/instructions.md
@@ -4,7 +4,7 @@ title: "Instructions"
 description: "Find out how to update to a new version of Optimize without losing your reports and dashboards."
 ---
 
-Roughly every quarter of a year a new minor version of Optimize is released. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
+Optimize releases two new minor versions a year. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
 
 If you want to update Optimize by several versions, you cannot do that at once, but you need to perform the updates in sequential order. For instance, if you want to update from 2.5 to 3.0, you need to update first from 2.5 to 2.6, then from 2.6 to 2.7, and finally from 2.7 to 3.0. The following table shows the recommended update paths to the latest version:
 

diff --git a/...version-3.7.0/self-managed/optimize-deployment/migration-update/instructions.md b/...version-3.7.0/self-managed/optimize-deployment/migration-update/instructions.md
@@ -6,7 +6,7 @@ description: "Find out how to update to a new version of Optimize without losing
 
 <span class="badge badge--platform">Camunda Platform 7 only</span>
 
-Roughly every quarter of a year a new minor version of Optimize is released. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
+Optimize releases two new minor versions a year. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
 
 If you want to update Optimize by several versions, you cannot do that at once, but you need to perform the updates in sequential order. For instance, if you want to update from 2.5 to 3.0, you need to update first from 2.5 to 2.6, then from 2.6 to 2.7, and finally from 2.7 to 3.0. The following table shows the recommended update paths to the latest version:
 

diff --git a/...version-3.8.0/self-managed/optimize-deployment/migration-update/instructions.md b/...version-3.8.0/self-managed/optimize-deployment/migration-update/instructions.md
@@ -4,7 +4,7 @@ title: "Instructions"
 description: "Find out how to update to a new version of Optimize without losing your reports and dashboards."
 ---
 
-Roughly every quarter of a year a new minor version of Optimize is released. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
+Optimize releases two new minor versions a year. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
 
 If you want to update Optimize by several versions, you cannot do that at once, but you need to perform the updates in sequential order. For instance, if you want to update from 2.5 to 3.0, you need to update first from 2.5 to 2.6, then from 2.6 to 2.7, and finally from 2.7 to 3.0. The following table shows the recommended update paths to the latest version:
 

diff --git a/...version-3.9.0/self-managed/optimize-deployment/migration-update/instructions.md b/...version-3.9.0/self-managed/optimize-deployment/migration-update/instructions.md
@@ -4,7 +4,7 @@ title: "Instructions"
 description: "Find out how to update to a new version of Optimize without losing your reports and dashboards."
 ---
 
-Roughly every quarter of a year a new minor version of Optimize is released. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
+Optimize releases two new minor versions a year. These documents guide you through the process of migrating your Optimize from one Optimize minor version to the other.
 
 If you want to update Optimize by several versions, you cannot do that at once, but you need to perform the updates in sequential order. For instance, if you want to update from 2.5 to 3.0, you need to update first from 2.5 to 2.6, then from 2.6 to 2.7, and finally from 2.7 to 3.0. The following table shows the recommended update paths to the latest version:
 

diff --git a/sidebars.js b/sidebars.js
@@ -1097,8 +1097,8 @@ module.exports = {
               "self-managed/optimize-deployment/migration-update/instructions/"
             ),
             optimizeLink(
-              "Update notes (3.10.x to 3.11)",
-              "self-managed/optimize-deployment/migration-update/3.10-to-3.11/"
+              "Update notes (3.10.x to 7.20/8.3)",
+              "self-managed/optimize-deployment/migration-update/3.10-to-7.20_8.3/"
             ),
             optimizeLink(
               "Update notes (3.9.x to 3.10)",

diff --git a/static/.htaccess b/static/.htaccess
@@ -8,6 +8,9 @@ Options -Indexes -MultiViews
 
 # Redirect pages - https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule
 
+# Optimize 3.11 release became the 7.20/8.3 releases
+RewriteRule ^docs/self-managed/optimize-deployment/migration-update/3.10-to-3.11(.*)$ /docs/self-managed/optimize-deployment/migration-update/3.10-to-7.20_8.3 [R=301,L]
+
 # rename Desktop Modeler reference to Camunda Cloud
 RewriteRule ^docs/next/components/modeler/desktop-modeler/connect-to-camunda-cloud/(.*)$ /docs/next/components/modeler/desktop-modeler/connect-to-camunda-platform-8/$1 [R=301,L]
 RewriteRule ^docs/components/modeler/desktop-modeler/connect-to-camunda-cloud/(.*)$ /docs/components/modeler/desktop-modeler/connect-to-camunda-platform-8/$1 [R=301,L]