[BEAM-9219] Streamline creation of Python and Java dependencies pages #10745
Conversation
I worry that keeping these tables will lead to the expectation that we'll create more tables. Based on the feedback of the Java deps page, it seems to be confusing to just have tables for some of the old versions. |
I agree with Cyrus. If it's the same process to access the old information as listed here, it's confusing to stop at an old version and might make this page look stale. |
Sounds good. If the new procedure could get the same information as the tables let's drop it. And if it cannot, that means we need to improve the new process. |
|
LGTM after updating "compile and runtime dependencies" in the Python deps doc to "dependencies" per Valentyn's comment |
|
@tvalentyn I incorporated the majority of your feedback, but left the venv instructions in for Python 3 as that seems to be the guidance from python.org. |
|
LGTM, thank you! |
| https://raw.githubusercontent.com/apache/beam/v<version_number>/sdks/python/setup.py | ||
| ``` | ||
|
|
||
| Replace `<version_number>` with the major.minor.patch version of the SDK. For example, <https://raw.githubusercontent.com/apache/beam/v2.18.0/sdks/python/setup.py>{:target="_blank"} will provide the dependencies for the 2.18.0 release. |
There was a problem hiding this comment.
I looked at the staged website: I think the documentation may be more user-friendly and the link we give in "For example" points to a place in the file where requirements are defined instead of the beginning of the file.
We could use 'https://github.com/apache/beam/...' instead of raw URL for this purpose. What do you think?
Same about BeamModulePlugin reference.
There was a problem hiding this comment.
As long as that is consistent between versions of the file (for supported SDKs), then I think that makes sense.
|
retest this please |
davidwrede
force-pushed
the
dep-page-update
branch
from
9a29c91
to
02a20fb
Compare
|
test |
|
|
||
| <details><summary markdown="span"><b>2.9.0</b></summary> | ||
| 1. Open `BeamModulePlugin.groovy`. |
There was a problem hiding this comment.
Can we link the file to the latest file?
[`BeamModulePlugin.groovy`](https://raw.githubusercontent.com/apache/beam/v{{ site.release_latest }}/buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy)
There was a problem hiding this comment.
I don't want to do it here. The point of this step is to show which file the reader should look in and which placeholder they should substitute.
The example now shows (and links) to the latest version of the file.
Signed-off-by: Dave Wrede <dwrede@dwrede-macbookpro.roam.corp.google.com>
davidwrede
force-pushed
the
dep-page-update
branch
from
02a20fb
to
23686df
Compare
|
Please don't squash reviewed and unreviewed commits in future PRs as it is difficult to see the diff, see: https://beam.apache.org/contribute/#make-reviewers-job-easier. |
|
Sorry about that @tvalentyn. Will remember that for next time. |
|
test |
|
Looks like tests are not running again... |
|
Run Website_Stage_GCS PreCommit |
|
Run Website PreCommit |
|
LGTM :) |
|
Run Website_Stage_GCS PreCommit |
|
Run Website PreCommit |
|
Run Website_Stage_GCS PreCommit |
Remove Java and Python SDK dependency tables from the docs and refer people to the source code or alternative methods to get this information.
R: @tvalentyn, @davidcavazos
CC: @aaltay, @rosetn, @soyrice
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
R: @username).[BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replaceBEAM-XXXwith the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.See the Contributor Guide for more tips on how to make review process smoother.
Post-Commit Tests Status (on master branch)
Pre-Commit Tests Status (on master branch)
See .test-infra/jenkins/README for trigger phrase, status and link of all Jenkins jobs.