-
Notifications
You must be signed in to change notification settings - Fork 441
doc(v3): migration guide edits #15950
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
doc(v3): migration guide edits #15950
Conversation
Summary of ChangesHello @scotthart, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the v3 migration guide documentation by reorganizing content related to build system changes and decommissioned API surfaces. The changes aim to improve clarity and structure, making it easier for users to navigate information about Bazel module integration and specific header file removals. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request improves the v3 migration guide by reorganizing sections for better clarity and adding information about decommissioned APIs. The changes are well-structured and make the guide easier to follow. I have one minor suggestion to improve the grammar in one of the updated lines.
doc/v3-migration-guide.md
Outdated
| ### Relocated Dependencies | ||
|
|
||
| - `crc32c` | ||
| - `crc32c` Is now distributed as part of Abseil. |
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.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## prepare-for-v3.0.0 #15950 +/- ##
===================================================
Coverage 92.61% 92.62%
===================================================
Files 2332 2332
Lines 213322 213322
===================================================
+ Hits 197568 197587 +19
+ Misses 15754 15735 -19 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
coryan
left a comment
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.
A few suggestions in style. I like the use of <details>. The guide is not too long, but provides more information where needed.
"The passive voice should never be used"
doc/v3-migration-guide.md
Outdated
| ### Relocated Dependencies | ||
|
|
||
| - `crc32c` | ||
| - `crc32c` Is now distributed as part of Abseil. |
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 am not sure you need to say that? Maybe just "google-cloud-cpp now uses the crc32c implementation in Abseil"? I am not sure it matters that the implementation is distributed with Abseil or not.
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.
Done.
| ### Bazel | ||
|
|
||
| <details> | ||
| <summary>google-cloud-cpp module in Bazel Central Registry</summary> |
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.
Are you still supporting customers with workspaces? If not, just say that?
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.
Updated to describe WORKSPACE support going forward.
doc/v3-migration-guide.md
Outdated
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.
s/the CMakeLists.txt/your CMakeLists.txt`
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.
Done.
doc/v3-migration-guide.md
Outdated
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.
s/The deprecated /The deprecated class / ?
PS: you know I do not like the passive voice. "We removed the bigtable::ClientOptions class in this release. We had deprecated this class in ...".
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.
Done.
doc/v3-migration-guide.md
Outdated
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.
As opposed to the counterfeit migration guide? Just say "migration guide".
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.
Done.
|
I made a lot of edits to switch from passive voice to active voice. |
doc/v3-migration-guide.md
Outdated
| new API surfaces that supersede the previous deprecated types and functions. As | ||
| part of the v3 release series, we are decommissioning those deprecated API | ||
| surfaces. This guide serves a central location to document how to migrate from | ||
| surfaces. This guide provides a central location to document how to migrate from |
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.
Are we repeating things?
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.
Reworded.
eb70ac5 to
9778333
Compare
2d1b10a
into
googleapis:prepare-for-v3.0.0
This change is