[
https://issues.apache.org/jira/browse/BEAM-13011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Work on BEAM-13011 started by David Huntsperger.
------------------------------------------------
> Improve xlang docs
> ------------------
>
> Key: BEAM-13011
> URL: https://issues.apache.org/jira/browse/BEAM-13011
> Project: Beam
> Issue Type: Improvement
> Components: cross-language, website
> Reporter: Reza ardeshir rokni
> Assignee: David Huntsperger
> Priority: P2
> Labels: stale-P2
>
> The documentation for xlang components is a mix of tutorial, guide and how to
> which is very difficult to follow, especially if coming to Xlang for the
> first time.
> [http://beam.apache.org/documentation/programming-guide/#multi-language-pipelines|https://www.google.com/url?q=http://beam.apache.org/documentation/programming-guide/%23multi-language-pipelines&sa=D&usg=AOvVaw0EhoMT9ttwomsjsIY6dUDT]
> I would recommend:
> 1-
> That talk from Beam summit :
> [https://www.youtube.com/watch?v=bt5DMP9Cwz0]
> Be replicated within the docs, including the rpc calls between the expansion
> service and other components that he references in the talk.
> 2-
> Separate out the guide material from tutorial as two different pieces
> 3-
> Provide a Hello world Python in Java and Java in Python example which
> includes full working commands.
> 5-
> We reference classes in :
>
> [https://github.com/apache/beam/blob/master/sdks/python/apache_beam/transforms/external.py|https://www.google.com/url?q=https://github.com/apache/beam/blob/master/sdks/python/apache_beam/transforms/external.py&sa=D&usg=AOvVaw2G3MS4kKmMPRlCL8-wg4Rg]
> But we dont really say how those classes should be run, this should also be
> part of the tutorial.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
