Updates Managed Javadocs and pydocs to refer to runner specific features #34072
Conversation
|
R: @ahmedabu98 |
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #34072 +/- ##
============================================
+ Coverage 57.70% 57.75% +0.05%
Complexity 1474 1474
============================================
Files 993 995 +2
Lines 157383 157599 +216
Branches 1076 1076
============================================
+ Hits 90815 91026 +211
- Misses 64321 64326 +5
Partials 2247 2247
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
chamikaramj
force-pushed
the
update_managed_documentation_2
branch
from
3db597f to
580c116
Compare
|
Don't think the errors are related to this PR. |
chamikaramj
force-pushed
the
update_managed_documentation_2
branch
from
580c116 to
9b9bfa9
Compare
There was a problem hiding this comment.
Would it help to also have some documentation on how Managed works? If I'm an external user, it'd feel pretty opaque and "magical" to me.
For example, documenting the journey of a SchemaTransform identifier + configuration and what power the runner has exactly to replace things.
| * <h3>Runner specific features</h3> | ||
| * | ||
| * Google Cloud Dataflow supports additional management features for {@code Managed} including | ||
| * automatically upgrading transforms to the latest supported version. For more details and | ||
| * examples, please see <a href="https://cloud.google.com/dataflow/docs/guides/managed-io">Dataflow | ||
| * managed I/O</a>. | ||
| * |
There was a problem hiding this comment.
I think keeping this text it in Managed is enough? Not sure if it belongs in the IO doc, and to be consistent we'd also need to include it for other Managed IOs
There was a problem hiding this comment.
Makes sense. Reverted updates to this file.
chamikaramj
force-pushed
the
update_managed_documentation_2
branch
from
9b9bfa9 to
c6dee85
Compare
There was a problem hiding this comment.
Would it help to also have some documentation on how Managed works? If I'm an external user, it'd feel pretty opaque and "magical" to me.
I think the linked Dataflow documentation explains this (some of the implementation details are internal to Dataflow)
For example, documenting the journey of a SchemaTransform identifier + configuration and what power the runner has exactly to replace things.
I think this is more of implementation detail and not useful to an end-user.
| * <h3>Runner specific features</h3> | ||
| * | ||
| * Google Cloud Dataflow supports additional management features for {@code Managed} including | ||
| * automatically upgrading transforms to the latest supported version. For more details and | ||
| * examples, please see <a href="https://cloud.google.com/dataflow/docs/guides/managed-io">Dataflow | ||
| * managed I/O</a>. | ||
| * |
There was a problem hiding this comment.
Makes sense. Reverted updates to this file.
Please add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.