Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 9 commits into from
Sep 7, 2023
Merged

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

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
aa1adfd
chore(docs): update optimize update guides to use correct version
RomanJRW Aug 29, 2023
63d694e
Update optimize/self-managed/optimize-deployment/migration-update/3.1…
akeller Aug 30, 2023
06b9a6c
more updates for 7.20_8.3
akeller Sep 1, 2023
fcce7cf
update update chart
akeller Sep 1, 2023
6fae5eb
Merge branch 'main' of https://github.com/camunda/camunda-platform-do…
akeller Sep 1, 2023
edddbaa
Merge branch 'main' into use_optimize_720_83_for_update_guide
akeller Sep 1, 2023
17efbe1
review fixes
akeller Sep 5, 2023
b927f54
replace last 3.11 to 7.20/8.3
misiekhardcore Sep 6, 2023
aaccfc2
Merge branch 'main' into use_optimize_720_83_for_update_guide
misiekhardcore Sep 6, 2023
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
14 changes: 7 additions & 7 deletions ...ployment/migration-update/3.10-to-3.11.md → ...ment/migration-update/3.10-to-7.20_8.3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -42,13 +42,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

Expand Down
14 changes: 7 additions & 7 deletions optimize/self-managed/optimize-deployment/migration-update/instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
akeller marked this conversation as resolved.
Show resolved Hide resolved

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. |
Comment on lines +11 to +16
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this true for the update path to 7.20/8.3? Or are there other changes that need to be made in the migration instruction section to support this or the 3.7 to 7.20/8.3 path?


## Migration instructions

Expand Down
2 changes: 1 addition & 1 deletion optimize_sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Visually, the underscore looks great. Good choice!

"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",
Expand Down
4 changes: 2 additions & 2 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1095,8 +1095,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)",
Expand Down
3 changes: 3 additions & 0 deletions static/.htaccess
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading