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 2022/04/06 17:47:45 UTC
[GitHub] [beam] rszper opened a new pull request, #17300: BEAM-13582 Fixing broken links in the documentation
rszper opened a new pull request, #17300:
URL: https://github.com/apache/beam/pull/17300
Fixing the broken links in the documentation identified in [BEAM-13582](https://issues.apache.org/jira/browse/BEAM-13582)
------------------------
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).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854549437
##########
website/www/site/content/en/documentation/runtime/environments.md:
##########
@@ -102,7 +102,7 @@ This method requires building image artifacts from Beam source. For additional i
git checkout origin/release-$BEAM_SDK_VERSION
```
-2. Customize the `Dockerfile` for a given language, typically `sdks/<language>/container/Dockerfile` directory (e.g. the [Dockerfile for Python](https://github.com/apache/beam/blob/master/sdks/python/container/Dockerfile). If you're adding dependencies from [PyPI](https://pypi.org/), use [`base_image_requirements.txt`](https://github.com/apache/beam/blob/master/sdks/python/container/base_image_requirements.txt) instead.
+2. Customize the `Dockerfile` for a given language, typically `sdks/<language>/container/Dockerfile` directory (e.g. the [Dockerfile for Python](https://github.com/apache/beam/blob/master/sdks/python/container/Dockerfile). If you're adding dependencies from [PyPI](https://pypi.org/), use [`base_image_requirements.txt`](https://github.com/apache/beam/blob/master/sdks/python/container/py38/base_image_requirements.txt) instead.
Review Comment:
Removed
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] asf-ci commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
asf-ci commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1090555464
Can one of the admins verify this patch?
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn closed pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
tvalentyn closed pull request #17300: BEAM-13582 Fixing broken links in the documentation
URL: https://github.com/apache/beam/pull/17300
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854544084
##########
website/www/site/content/en/documentation/resources/learning-resources.md:
##########
@@ -97,8 +97,7 @@ If you have additional material that you would like to see here, please let us k
### Python
-* **[Python Qwik Start](https://qwiklabs.com/focuses/1100?locale=en&parent=catalog)** (30m) - Run a word count pipeline on the Dataflow runner.
-* **[NDVI from Landsat Images](https://qwiklabs.com/focuses/1849?locale=en&parent=catalog)** (45m) - Process Landsat satellite data in a distributed environment to compute the [Normalized Difference Vegetation Index](https://en.wikipedia.org/wiki/Normalized_difference_vegetation_index) (NDVI).
+* **[Python Qwik Start](https://www.qwiklabs.com/focuses/1098?parent=catalog)** (30m) - Run a word count pipeline on the Dataflow runner.
Review Comment:
If I search for the Python Qwik Start in the catalog, when I click on it, I'm routed to the 1098 URL, which is why I think that's the current URL. The 1100 URL still works, but you can't navigate to that from the catalog; you can only get there using the direct link.
I did a bunch of searches to try to find out if the NDVI lab had been moved to a different location, but from what I can tell, it's entirely gone. I don't know if there's a new lab that we would want to use in its place.
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854549789
##########
website/www/site/content/en/blog/review-input-streaming-connectors.md:
##########
@@ -184,15 +184,15 @@ and <a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.h
</td>
<td>N/A
</td>
- <td><a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.html#pyspark.streaming.kafka.KafkaUtils">KafkaUtils</a>
+ <td><a href="https://spark.apache.org/docs/latest/streaming-kafka-0-10-integration.html">KafkaUtils</a>
</td>
</tr>
<tr>
<td>Kinesis
</td>
<td>N/A
</td>
- <td><a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.html#module-pyspark.streaming.kinesis">KinesisUtils</a>
+ <td><a href="https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.streaming.kinesis.KinesisUtils.createStream.html">KinesisUtils</a>
Review Comment:
Updated.
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854393950
##########
website/www/site/content/en/contribute/release-guide.md:
##########
@@ -584,7 +584,7 @@ See the source of the script for more details, or to run commands manually in ca
1. Select repository `orgapachebeam-NNNN`.
1. Click the Close button.
1. When prompted for a description, enter “Apache Beam, version X, release candidate Y”.
- 1. Review all staged artifacts on https://repository.apache.org/content/repositories/orgapachebeam-NNNN/.
+ 1. Review all staged artifacts in the `orgapachebeam-NNNN` repository on https://repository.apache.org/content/repositories.
Review Comment:
That's a good point. I think formatting this as text rather than making it a link is the right approach. I'll make that update.
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
tvalentyn commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854428337
##########
website/www/site/content/en/documentation/resources/learning-resources.md:
##########
@@ -97,8 +97,7 @@ If you have additional material that you would like to see here, please let us k
### Python
-* **[Python Qwik Start](https://qwiklabs.com/focuses/1100?locale=en&parent=catalog)** (30m) - Run a word count pipeline on the Dataflow runner.
-* **[NDVI from Landsat Images](https://qwiklabs.com/focuses/1849?locale=en&parent=catalog)** (45m) - Process Landsat satellite data in a distributed environment to compute the [Normalized Difference Vegetation Index](https://en.wikipedia.org/wiki/Normalized_difference_vegetation_index) (NDVI).
+* **[Python Qwik Start](https://www.qwiklabs.com/focuses/1098?parent=catalog)** (30m) - Run a word count pipeline on the Dataflow runner.
Review Comment:
not sure what's the difference in the urls for the first link; both ...1098... and ...1100... work for me (after signing in with Qwiklabs). the removed `NDVI from Landsat Images` link did not work, indeed.
##########
website/www/site/content/en/documentation/sdks/go.md:
##########
@@ -28,7 +28,7 @@ This means worker binaries may need to be [cross-compiled](/documentation/sdks/g
Get started with the [Beam Go SDK quickstart](/get-started/quickstart-go) to set up your development environment and run an example pipeline. Then, read through the [Beam programming guide](/documentation/programming-guide) to learn the basic concepts that apply to all SDKs in Beam.
-See the [godoc](https://pkg.go.dev/github.com/apache/beam/sdks/v2/go/pkg/beam) for more detailed information.
+See the [godoc](https://pkg.go.dev/github.com/apache/beam/sdks/go/pkg/beam) for more detailed information.
Review Comment:
What's the reason for this change? Both links work. I think v2 refers to documentation for newer SDKs and will be used going forward.
##########
website/www/site/content/en/blog/review-input-streaming-connectors.md:
##########
@@ -184,15 +184,15 @@ and <a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.h
</td>
<td>N/A
</td>
- <td><a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.html#pyspark.streaming.kafka.KafkaUtils">KafkaUtils</a>
+ <td><a href="https://spark.apache.org/docs/latest/streaming-kafka-0-10-integration.html">KafkaUtils</a>
Review Comment:
this is an old blog and the info is outdated.
@rszper you could perhaps reference older version of pyspark to preserve the original narrative.
https://spark.apache.org/docs/2.4.8/api/python/pyspark.streaming.html#pyspark.streaming.kafka.KafkaUtils
##########
website/www/site/content/en/documentation/runtime/environments.md:
##########
@@ -102,7 +102,7 @@ This method requires building image artifacts from Beam source. For additional i
git checkout origin/release-$BEAM_SDK_VERSION
```
-2. Customize the `Dockerfile` for a given language, typically `sdks/<language>/container/Dockerfile` directory (e.g. the [Dockerfile for Python](https://github.com/apache/beam/blob/master/sdks/python/container/Dockerfile). If you're adding dependencies from [PyPI](https://pypi.org/), use [`base_image_requirements.txt`](https://github.com/apache/beam/blob/master/sdks/python/container/base_image_requirements.txt) instead.
+2. Customize the `Dockerfile` for a given language, typically `sdks/<language>/container/Dockerfile` directory (e.g. the [Dockerfile for Python](https://github.com/apache/beam/blob/master/sdks/python/container/Dockerfile). If you're adding dependencies from [PyPI](https://pypi.org/), use [`base_image_requirements.txt`](https://github.com/apache/beam/blob/master/sdks/python/container/py38/base_image_requirements.txt) instead.
Review Comment:
Let's remove If you're adding ... sentence.
##########
website/www/site/content/en/blog/review-input-streaming-connectors.md:
##########
@@ -184,15 +184,15 @@ and <a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.h
</td>
<td>N/A
</td>
- <td><a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.html#pyspark.streaming.kafka.KafkaUtils">KafkaUtils</a>
+ <td><a href="https://spark.apache.org/docs/latest/streaming-kafka-0-10-integration.html">KafkaUtils</a>
</td>
</tr>
<tr>
<td>Kinesis
</td>
<td>N/A
</td>
- <td><a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.html#module-pyspark.streaming.kinesis">KinesisUtils</a>
+ <td><a href="https://spark.apache.org/docs/latest/api/python/reference/api/pyspark.streaming.kinesis.KinesisUtils.createStream.html">KinesisUtils</a>
Review Comment:
ditto
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] asf-ci commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
asf-ci commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1090555463
Can one of the admins verify this patch?
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854546091
##########
website/www/site/content/en/blog/review-input-streaming-connectors.md:
##########
@@ -184,15 +184,15 @@ and <a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.h
</td>
<td>N/A
</td>
- <td><a href="https://spark.apache.org/docs/latest/api/python/pyspark.streaming.html#pyspark.streaming.kafka.KafkaUtils">KafkaUtils</a>
+ <td><a href="https://spark.apache.org/docs/latest/streaming-kafka-0-10-integration.html">KafkaUtils</a>
Review Comment:
Good idea.
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1090572836
R: @tvalentyn
R: @pcoet
R: @melap
R: @timrobertson100
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
tvalentyn commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854368122
##########
website/www/site/content/en/contribute/release-guide.md:
##########
@@ -584,7 +584,7 @@ See the source of the script for more details, or to run commands manually in ca
1. Select repository `orgapachebeam-NNNN`.
1. Click the Close button.
1. When prompted for a description, enter “Apache Beam, version X, release candidate Y”.
- 1. Review all staged artifacts on https://repository.apache.org/content/repositories/orgapachebeam-NNNN/.
+ 1. Review all staged artifacts in the `orgapachebeam-NNNN` repository on https://repository.apache.org/content/repositories.
Review Comment:
this wording was intentional. Each release, a repository is assigned a unique ID, which keeps changing. For example, right now there is https://repository.apache.org/content/repositories/orgapachebeam-1256. Perhaps we can make escape this link so that the broken-links parser doesn't pick it up?
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] asf-ci commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
asf-ci commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1090555460
Can one of the admins verify this patch?
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
tvalentyn commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1105087097
Thank you!
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] rszper commented on a diff in pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
rszper commented on code in PR #17300:
URL: https://github.com/apache/beam/pull/17300#discussion_r854549646
##########
website/www/site/content/en/documentation/sdks/go.md:
##########
@@ -28,7 +28,7 @@ This means worker binaries may need to be [cross-compiled](/documentation/sdks/g
Get started with the [Beam Go SDK quickstart](/get-started/quickstart-go) to set up your development environment and run an example pipeline. Then, read through the [Beam programming guide](/documentation/programming-guide) to learn the basic concepts that apply to all SDKs in Beam.
-See the [godoc](https://pkg.go.dev/github.com/apache/beam/sdks/v2/go/pkg/beam) for more detailed information.
+See the [godoc](https://pkg.go.dev/github.com/apache/beam/sdks/go/pkg/beam) for more detailed information.
Review Comment:
Switched back to v2. Thank you for pointing this out.
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] tvalentyn merged pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
tvalentyn merged PR #17300:
URL: https://github.com/apache/beam/pull/17300
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] asf-ci commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
asf-ci commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1090555466
Can one of the admins verify this patch?
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] asf-ci commented on pull request #17300: BEAM-13582 Fixing broken links in the documentation
Posted by GitBox <gi...@apache.org>.
asf-ci commented on PR #17300:
URL: https://github.com/apache/beam/pull/17300#issuecomment-1090555461
Can one of the admins verify this patch?
--
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.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org