Skip to content

Add Breaking Changes viewer to assessing-your-cluster-for-migration.md #9443

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

Jump to bottom
Merged
merged 9 commits into from
Apr 8, 2025
Merged

Add Breaking Changes viewer to assessing-your-cluster-for-migration.md #9443

merged 9 commits into from
Apr 8, 2025

Conversation

AndreKurait
Copy link
Member

@AndreKurait AndreKurait commented Mar 18, 2025 •
edited
Loading

Description

Add Breaking Changes viewer for migration assistant assessment with links for transformations.

Aligns migration paths with supported migrations in a generated table

Issues Resolved

Closes MIGRATIONS-2416

Version

Migration Assistant

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

BreakingChanges.mp4

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@AndreKurait AndreKurait marked this pull request as draft March 18, 2025 15:31
@github-actions GitHub Actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

peternied
peternied reviewed Mar 18, 2025
View reviewed changes
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

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

Really impressive visual, I've got some more dev-centric questions before digging in on the content.

@Naarcha-AWS
Copy link
Collaborator

@AndreKurait: Let me know when you want me to review this one.

@AndreKurait AndreKurait force-pushed the MIGRATIONS-2416 branch 2 times, most recently from 89e1dd3 to 6924277 Compare March 26, 2025 15:29
@AndreKurait AndreKurait marked this pull request as ready for review March 26, 2025 16:59
@AndreKurait
Copy link
Member Author

AndreKurait commented Mar 26, 2025 •
edited
Loading

@peternied, ready for your review, video on overview is updated

peternied
peternied approved these changes Mar 26, 2025
View reviewed changes
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

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

I'd recommend iterating on some of these comments, but nothing critical to block merging. Thanks for making these improvements.

_data/migration-assistant/breaking-changes.yml
comp: []
- title: "OpenSearch 2.0: Remove mapping types parameter"
url: "/docs/latest/breaking-changes/#remove-mapping-types-parameter"
introducedIn: "OpenSearch 2.19"
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about making these major version only? Otherwise we need to update this in many different positions on a version update.

Suggested change
introducedIn: "OpenSearch 2.19"
introducedIn: "OpenSearch 2.X"

Alternatively, introducedIn implies these changes should have appeared in the first version of OpenSearch 2.0, no?

I'd recommend being less specific for now and we can always build up if we want.

Copy link
Member Author

Choose a reason for hiding this comment

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

The versions here match the versions on supported migrations.
image

Copy link
Member

Choose a reason for hiding this comment

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

🤷 It reads strange when looking in the non-table view. Not a blocker.

@AndreKurait
Address PR Comments
a2b4c32 
Signed-off-by: Andre Kurait <[email protected]>
@peternied
Copy link
Member

@Naarcha-AWS Looks good to me

@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress backport 2.19 labels Mar 28, 2025
@AndreKurait
Copy link
Member Author

@Naarcha-AWS I see some updates were made on Friday, any remaining work before we can merge this in?

@peternied
Copy link
Member

@Naarcha-AWS Could you take another look? Seems like this is pretty much wrapped, is there anything else that needs to be done?

natebower
natebower reviewed Apr 4, 2025
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS Please see my rewrites and let me know if you have any questions. Thanks!

@Naarcha-AWS Naarcha-AWS merged commit 9fc798e into opensearch-project:main Apr 8, 2025
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 8, 2025
@github-actions @Naarcha-AWS
Add Breaking Changes viewer to assessing-your-cluster-for-migration.md (
e034850 
#9443)

* Add Breaking Changes selector to assessing-your-cluster-for-migration.md

Signed-off-by: Andre Kurait <[email protected]>

* Save progress with using data file for shared Migration Paths

Signed-off-by: Andre Kurait <[email protected]>

* Refactor breaking changes for migration assistant

Signed-off-by: Andre Kurait <[email protected]>

* Move breaking changes to data yml

Signed-off-by: Andre Kurait <[email protected]>

* Update to define breaking changes in yml

Signed-off-by: Andre Kurait <[email protected]>

* Filter target cluster selection list and fix page prepopulated with source and target

Signed-off-by: Andre Kurait <[email protected]>

* Address PR Comments

Signed-off-by: Andre Kurait <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Andre Kurait <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 9fc798e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 8, 2025
Merged
github-actions bot pushed a commit that referenced this pull request Apr 8, 2025
@opensearch-trigger-bot
Add Breaking Changes viewer to assessing-your-cluster-for-migration.md (
4113072 
#9443) (#9580)
@AndreKurait AndreKurait deleted the MIGRATIONS-2416 branch April 8, 2025 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peternied peternied peternied approved these changes

@natebower natebower natebower left review comments

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@Naarcha-AWS Naarcha-AWS

Labels
4 - Doc review PR: Doc review in progress backport 2.19
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@AndreKurait @Naarcha-AWS @peternied @natebower @kolchfa-aws