You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2021/01/13 21:38:49 UTC
[GitHub] [beam] davidcavazos opened a new pull request #13747: Add Tour of Beam page
davidcavazos opened a new pull request #13747:
URL: https://github.com/apache/beam/pull/13747
Add a landing page for the "Tour of Beam" page. This consists of a linear path users can take to learn Apache Beam with interactive notebooks.
New notebooks will be added here to cover more topics.
R: @rosetn
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Dataflow | Flink | Samza | Spark | Twister2
--- | --- | --- | --- | --- | --- | ---
Go | [](https://ci-beam.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Spark/lastCompletedBuild/) | ---
Java | [](https://ci-beam.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Java11/lastCompletedBuild/) | [](https://ci-beam
.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Java11/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Spark_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_SparkStructuredStreaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Twister2/lastCompletedBuild/)
Python | [](https://ci-beam.apache.org/job/beam_PostCommit_Python36/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python37/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python38/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_PVR_Flink_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Spark/lastCompletedBuild/) | ---
XLang | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Direct/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Dataflow/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Spark/lastCompletedBuild/) | ---
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website | Whitespace | Typescript
--- | --- | --- | --- | --- | --- | ---
Non-portable | [](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonLint_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocker_Cron/lastCompletedBuild/) <br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocs_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Whitespace_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Typescript_Cron/lastCompletedBuild/)
Portable | --- | [](https://ci-beam.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/) | --- | --- | --- | ---
See [.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md) for trigger phrase, status and link of all Jenkins jobs.
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] TheNeuralBit merged pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
TheNeuralBit merged pull request #13747:
URL: https://github.com/apache/beam/pull/13747
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-784520602
I guess this can be merged now but needs a rebase?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] TheNeuralBit commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
TheNeuralBit commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-776121484
I think it would just work, but there may be some merge conflicts to resolve. Would you mind if we wait to merge this until after https://github.com/apache/beam/pull/13871 goes in?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-774330278
Thanks for the comments. I reverted to just using headers and normal text in favor of simplicity.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] TheNeuralBit commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
TheNeuralBit commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-784530022
Yes #13871 has been merged, it looks like there are just some minor conflicts to resolve
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] aaltay commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
aaltay commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-776114885
LGTM.
But there is a vote on replacing the web page on the dev@ list. If we merge this now would it be part of the new website? (/cc @TheNeuralBit)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on a change in pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on a change in pull request #13747:
URL: https://github.com/apache/beam/pull/13747#discussion_r571292994
##########
File path: website/www/site/content/en/get-started/tour-of-beam.md
##########
@@ -0,0 +1,73 @@
+---
+title: "Tour of Beam"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Tour of Beam
+
+Here you can find a collection of the interactive notebooks available for Apache Beam, which are hosted in
+[Colab](https://colab.research.google.com).
+The notebooks allow you to interactively play with the code and see how your changes affect the pipeline.
+You don't need to install anything or modify your computer in any way to use these notebooks.
+
+You can also [try an Apache Beam pipeline](/get-started/try-apache-beam) using the Java, Python, and Go SDKs.
+
+## Get started
+
+{{< table >}}
+<table>
+ <col style="width: auto;">
+ <col style="width: 200px;">
+ {{< row-colab
+ title="Learn the basics"
+ body="In this notebook we go through the basics of what is Apache Beam and how to get started."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/tour-of-beam/getting-started.ipynb" >}}
+</table>
+{{< /table >}}
+
+## Transforms
+
+Check the [Python transform catalog](/documentation/transforms/python/overview/)
+for a complete list of the available transforms.
+
+### Element-wise transforms
+
+{{< table >}}
+<table>
+ <col style="width: auto;">
+ <col style="width: 200px;">
+ {{< row-colab
+ title="Map"
+ body="Applies a simple one-to-one mapping function over each element in the collection."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/map-py.ipynb" >}}
+ {{< row-colab
+ title="FlatMap"
+ body="Applies a simple one-to-many mapping function over each element in the collection. The many elements are flattened into the resulting collection."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/flatmap-py.ipynb" >}}
+ {{< row-colab
+ title="Filter"
+ body="Given a predicate, filter out all elements that don’t satisfy that predicate."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/filter-py.ipynb" >}}
+ {{< row-colab
+ title="Partition"
+ body="Separates elements in a collection into multiple output collections."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/partition-py.ipynb" >}}
+ {{< row-colab
+ title="ParDo"
+ body="A transform for generic parallel processing. It's recommended to use Map, FlatMap, Filter or other more specific transforms when possible."
Review comment:
Done
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] TheNeuralBit commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
TheNeuralBit commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-785402513
Thanks! Sorry about the delay
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] davidcavazos commented on pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
davidcavazos commented on pull request #13747:
URL: https://github.com/apache/beam/pull/13747#issuecomment-775602111
Hi @aaltay, can you take a look at this whenever you have a chance? I think it might be ready to merge if you think so too.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rosetn commented on a change in pull request #13747: [BEAM-10937] Add Tour of Beam page
Posted by GitBox <gi...@apache.org>.
rosetn commented on a change in pull request #13747:
URL: https://github.com/apache/beam/pull/13747#discussion_r560559311
##########
File path: website/www/site/content/en/get-started/tour-of-beam.md
##########
@@ -0,0 +1,73 @@
+---
+title: "Tour of Beam"
+---
+
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Tour of Beam
+
+Here you can find a collection of the interactive notebooks available for Apache Beam, which are hosted in
+[Colab](https://colab.research.google.com).
+The notebooks allow you to interactively play with the code and see how your changes affect the pipeline.
+You don't need to install anything or modify your computer in any way to use these notebooks.
+
+You can also [try an Apache Beam pipeline](/get-started/try-apache-beam) using the Java, Python, and Go SDKs.
+
+## Get started
+
+{{< table >}}
+<table>
+ <col style="width: auto;">
+ <col style="width: 200px;">
+ {{< row-colab
+ title="Learn the basics"
+ body="In this notebook we go through the basics of what is Apache Beam and how to get started."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/tour-of-beam/getting-started.ipynb" >}}
+</table>
+{{< /table >}}
+
+## Transforms
+
+Check the [Python transform catalog](/documentation/transforms/python/overview/)
+for a complete list of the available transforms.
+
+### Element-wise transforms
+
+{{< table >}}
+<table>
+ <col style="width: auto;">
+ <col style="width: 200px;">
+ {{< row-colab
+ title="Map"
+ body="Applies a simple one-to-one mapping function over each element in the collection."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/map-py.ipynb" >}}
+ {{< row-colab
+ title="FlatMap"
+ body="Applies a simple one-to-many mapping function over each element in the collection. The many elements are flattened into the resulting collection."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/flatmap-py.ipynb" >}}
+ {{< row-colab
+ title="Filter"
+ body="Given a predicate, filter out all elements that don’t satisfy that predicate."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/filter-py.ipynb" >}}
+ {{< row-colab
+ title="Partition"
+ body="Separates elements in a collection into multiple output collections."
+ button_url="https://colab.research.google.com/github/apache/beam/blob/master/examples/notebooks/documentation/transforms/python/elementwise/partition-py.ipynb" >}}
+ {{< row-colab
+ title="ParDo"
+ body="A transform for generic parallel processing. It's recommended to use Map, FlatMap, Filter or other more specific transforms when possible."
Review comment:
I think we want this in code font
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org