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.

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

Conversation

RomanJRW
Copy link
Contributor

@RomanJRW RomanJRW commented Aug 29, 2023

Description

In line with the future Optimize versioning, this updates the update notes to use the future versioning system

When should this change go live?

The version changes comes with the next minor release, but earlier docs changes are also fine to help users get used to the new scheme

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@RomanJRW RomanJRW requested a review from akeller August 29, 2023 21:36
@akeller akeller added the component:optimize Issues related with Optimize project label Aug 30, 2023
@@ -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!

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

@misiekhardcore
Copy link
Contributor

I can see that optimize 3.11 is also mentioned in docs/reference/supported-environments.md. Do we have to change it there as well?

@akeller
Copy link
Member

akeller commented Sep 1, 2023

@misiekhardcore let's update it there too. 3.11 won't exist as far as I'm aware.

Copy link
Contributor

@misiekhardcore misiekhardcore left a comment

Choose a reason for hiding this comment

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

From my side the changes look good right now

@akeller
Copy link
Member

akeller commented Sep 7, 2023

@misiekhardcore I'll merge this in. When @RomanJRW is back, we can review and iterate to make sure this looks good for the minor release 💪 thank you!

@akeller akeller merged commit 339abe4 into main Sep 7, 2023
4 checks passed
@akeller akeller deleted the use_optimize_720_83_for_update_guide branch September 7, 2023 15:53
@akeller akeller mentioned this pull request Sep 12, 2023
9 tasks
pepopowitz pushed a commit that referenced this pull request Oct 16, 2024
)

* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:optimize Issues related with Optimize project
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants