[
https://issues.apache.org/jira/browse/BEAM-10937?focusedWorklogId=560288&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-560288
]
ASF GitHub Bot logged work on BEAM-10937:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 03/Mar/21 03:43
Start Date: 03/Mar/21 03:43
Worklog Time Spent: 10m
Work Description: rosetn commented on a change in pull request #14045:
URL: https://github.com/apache/beam/pull/14045#discussion_r586082067
##########
File path: examples/notebooks/tour-of-beam/reading-and-writing-data.ipynb
##########
@@ -0,0 +1,939 @@
+{
+ "nbformat": 4,
+ "nbformat_minor": 0,
+ "metadata": {
+ "colab": {
+ "name": "Reading and writing data -- Tour of Beam",
Review comment:
General note about this notebook: consider using text formatting more
discerningly. Overusing text formatting will cause the formatting to lose the
additional context and might make sentences more difficult to comprehend.
* If you're using italics to define terms, don't italicize words that you're
not trying to define or explain. I'm actually a little confused about why some
terms are italicized; it could be possible that you're trying to make a new
user aware of important terms. However, pulling these terms out in a bulleted
list to highlight them or naming your headers in a way to direct attention to
the term might be a better choice.
* On a similar note with bolding terms, I'm not sure why Source and Sink are
bolded.
* Here are some general guidelines:
https://developers.google.com/style/text-formatting. We don't need to follow
them strictly, but we should be deliberate in our choices.
----------------------------------------------------------------
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:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 560288)
Time Spent: 7h (was: 6h 50m)
> Create "Tour of Beam" introductory section
> ------------------------------------------
>
> Key: BEAM-10937
> URL: https://issues.apache.org/jira/browse/BEAM-10937
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: David Cavazos
> Priority: P3
> Time Spent: 7h
> Remaining Estimate: 0h
>
> Create a new "Tour of Beam" section in the docs, with links to all the
> notebooks we have to improve the onboarding experience for beginners.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
