-
-
Notifications
You must be signed in to change notification settings - Fork 22.7k
Add "See Migration Guide" button to the Project Manager #107623
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
Add "See Migration Guide" button to the Project Manager #107623
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the feature is fine as is, but I wonder if it'd be doable to send the user to a more specific, appropriate page if the difference is one minor or major release (such as "4.4 -> 4.5"), and if the page is available, of course.
9740424
to
4ec1db1
Compare
The feature is fine, but the main problem is that it introduces a real maintenance burden. Right now the button opens Godot 4.5 migration guide, and greets the user with page not found. That's not acceptable, and it means we need to make sure we have a migration guide ready at least for the stable release, for each version onward, even if the guide is going to be empty. I also wonder about the placement of the button. Wouldn't it be better if it was in the middle?
It would be best if we had a dedicated migration guide page that could generate its content dynamically. So you could open the page with current version and target version in the URL and it would copy-paste relevant guides between these versions. That's an overkill solution though. For now we could link previous and next migration guide in each page, so the user can quickly find them. |
9643b78
to
e4e1420
Compare
Fair points. I agree that the need to update the documentation beforehand to make the button work properly is an unnecessary burden. That's why I changed the link to a universal address describing the procedure for migration to the new versions. https://docs.godotengine.org/en/latest/tutorials/migrating/index.html As recommended, I use void ProjectManager::_migration_guide_button_pressed() {
const String url = vformat("%s/tutorials/migrating/index.html", GODOT_VERSION_DOCS_URL);
OS::get_singleton()->shell_open(url);
} As for the placement of the button, I'm using |
e4e1420
to
b4627b7
Compare
Thanks! |
Adds a “See Migration Guide” button to the project update warning window. When clicked, a documentation page opens in an external browser:
https://docs.godotengine.org/en/stable/tutorials/migrating/
upgrade from 4.x:

upgrade from 3.x:
