Skip to content

docs: add note about new executable name in migration guide#2403

Merged
jackwotherspoon merged 2 commits intoGoogleCloudPlatform:mainfrom
bseib:update-v2-migration-docs
Mar 10, 2025
Merged

docs: add note about new executable name in migration guide#2403
jackwotherspoon merged 2 commits intoGoogleCloudPlatform:mainfrom
bseib:update-v2-migration-docs

Conversation

@bseib
Copy link
Copy Markdown
Contributor

@bseib bseib commented Mar 8, 2025

It is a subtle difference to notice in all the examples that the executable name has changed from using underscores to hyphens. It would be helpful to the reader to have this explicitly pointed out, the same way that the other changes have been spelled out.

(Yes, it is obvious and self-evident when you are typing the old/new command on the command line that cloud_sql_proxy does not exist. But I lost a good bit time pinpointing this problem when it was inside a k8s container that had been converted from v1 to v2, even when I got all the new flag changes correct! 😀)

It is a subtle difference to notice in all the examples that the
executable name has changed from using underscores to hyphens.

It is helpful to the reader to have this explicitly pointed out, the
same way that the other changes have been spelled out.
@bseib bseib requested a review from a team as a code owner March 8, 2025 22:06
Copy link
Copy Markdown
Collaborator

@jackwotherspoon jackwotherspoon left a comment

Choose a reason for hiding this comment

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

Small nit, otherwise LGTM 👍

Thanks a ton for this @bseib 👏

Definitely worth explicitly calling out the name change.

Comment thread migration-guide.md Outdated
Comment thread migration-guide.md Outdated
@jackwotherspoon jackwotherspoon changed the title Add note about the new executable name docs: add note about new executable name in migration guide Mar 10, 2025
@jackwotherspoon jackwotherspoon merged commit f9bb03b into GoogleCloudPlatform:main Mar 10, 2025
11 checks passed
@jackwotherspoon
Copy link
Copy Markdown
Collaborator

Thanks again @bseib 😄

If you have any other general feedback about the Proxy or our docs, please let me know!

We definitely value feedback and will make sure to create docs/feature bugs for any enhancements or suggestions.

@bseib
Copy link
Copy Markdown
Contributor Author

bseib commented Mar 10, 2025

Thanks for the quick review and merge @jackwotherspoon !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants