[YAML] Several improvements to the documentation. #30007
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robertwb
changed the title
robertwb
force-pushed
the
yaml-create-doc
branch
from
4ad7784 to
26e8799
Compare
This was pointed out as a pain point by multiple people.
These will get updated when we have proper docs, but it's still good to surface what we have in the meantime.
robertwb
force-pushed
the
yaml-create-doc
branch
from
26e8799 to
e70a28a
Compare
Contributor
Author
|
R: @Polber |
Contributor
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control |
robertwb
force-pushed
the
yaml-create-doc
branch
from
f3f0f98 to
afd8b79
Compare
Polber
reviewed
Jan 19, 2024
Comment on lines
+75
to
+80
| You can do a dry-run of your pipeline using the render runner to see what the | ||
| execution graph is, e.g. | ||
|
|
||
| ``` | ||
| python -m apache_beam.yaml.main --yaml_pipeline_file=/path/to/pipeline.yaml --runner=apache_beam.runners.render.RenderRunner --render_output=out.png [--render_port=0] | ||
| ``` |
Contributor
There was a problem hiding this comment.
It might be nice to mention that graphviz must be installed. I had to install it using these instructions: https://graphviz.org/download/
Contributor
Author
There was a problem hiding this comment.
Good point. Added.
Co-authored-by: Jeff Kinard <jeff@thekinards.com>
Polber
approved these changes
Jan 29, 2024
| ``` | ||
|
|
||
| Currently, in addition to Python, SQL expressions are supported as well | ||
| Currently, in addition to Python, Java and SQL expressions are supported as well |
Contributor
There was a problem hiding this comment.
Might be nice to note experimental Javascript support
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.