[BEAM-1349] Update documentation to remove python-sdk branch references #136
Conversation
|
R: @davorbonaci |
|
Refer to this link for build results (access rights to CI server needed): |
|
Refer to this link for build results (access rights to CI server needed): Jenkins built the site at commit id a5fe014 with Jekyll and staged it here. Happy reviewing. Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again. |
| @@ -18,7 +18,7 @@ I want to share some of takeaways I had about Beam during the conference. | |||
|
|
|||
| The Data Engineers are looking to Beam as a way to [future-proof](https://www.oreilly.com/ideas/future-proof-and-scale-proof-your-code), meaning that code is portable between the various Big Data frameworks. In fact, many of the attendees were still on Hadoop MapReduce and looking to transition to a new framework. They’re realizing that continually rewriting code isn’t the most productive approach. | |||
|
|
|||
| Data Scientists are really interested in using Beam. They interested in having a single API for doing analysis instead of several different APIs. We talked about Beam’s progress on the Python API. If you want to take a peek, it’s being actively developed on a [feature branch](https://github.com/apache/beam/tree/python-sdk). As Beam matures, we’re looking to add other supported languages. | |||
| Data Scientists are really interested in using Beam. They interested in having a single API for doing analysis instead of several different APIs. We talked about Beam’s progress on the Python API. If you want to take a peek, it’s being actively developed on a [feature branch](https://github.com/apache/beam/tree/master/sdks/python). As Beam matures, we’re looking to add other supported languages. | |||
| @@ -25,7 +25,7 @@ Current branches include: | |||
| | Feature | Branch | JIRA Component | More Info | | |||
| | ---- | ---- | ---- | ---- | | |||
| | Apache Gearpump Runner | [gearpump-runner](https://github.com/apache/beam/tree/gearpump-runner) | [runner-gearpump](https://issues.apache.org/jira/browse/BEAM/component/12330829) | [README](https://github.com/apache/beam/blob/gearpump-runner/runners/gearpump/README.md) | | |||
| | Python SDK | [python-sdk](https://github.com/apache/beam/tree/python-sdk) | [sdk-py](https://issues.apache.org/jira/browse/BEAM/component/12328910) | [README](https://github.com/apache/beam/blob/python-sdk/sdks/python/README.md) | | |||
| | Python SDK | [python-sdk](https://github.com/apache/beam/tree/master/sdks/python) | [sdk-py](https://issues.apache.org/jira/browse/BEAM/component/12328910) | [README](https://github.com/apache/beam/blob/master/sdks/python/README.md) | | |||
There was a problem hiding this comment.
drop the python README.md and/or integrate it to main?
There was a problem hiding this comment.
I think there is value in keeping that README. It contains folder specific information. Or we can merge that information back to top level README. I prefer the first option, but I think both makes sense.
There was a problem hiding this comment.
This is list of feature branches -- Python SDK like should be removed from here, not updated.
Regarding the README.md file -- they are not discoverable if they are deep in the structure, so they make little impact and it is hard to keep them up-to-date. Most important information should go to the top-level README, and everything else to the website under Documentation -> SDKs -> Python SDK. This is nicely formatted, searchable, visible, etc.
There was a problem hiding this comment.
Done, removed from the list.
https://issues.apache.org/jira/browse/BEAM-1359 - for moving the README.md file content to top level README.md and to website as appropriate.
| @@ -25,7 +25,7 @@ Current branches include: | |||
| | Feature | Branch | JIRA Component | More Info | | |||
| | ---- | ---- | ---- | ---- | | |||
| | Apache Gearpump Runner | [gearpump-runner](https://github.com/apache/beam/tree/gearpump-runner) | [runner-gearpump](https://issues.apache.org/jira/browse/BEAM/component/12330829) | [README](https://github.com/apache/beam/blob/gearpump-runner/runners/gearpump/README.md) | | |||
| | Python SDK | [python-sdk](https://github.com/apache/beam/tree/python-sdk) | [sdk-py](https://issues.apache.org/jira/browse/BEAM/component/12328910) | [README](https://github.com/apache/beam/blob/python-sdk/sdks/python/README.md) | | |||
| | Python SDK | [python-sdk](https://github.com/apache/beam/tree/master/sdks/python) | [sdk-py](https://issues.apache.org/jira/browse/BEAM/component/12328910) | [README](https://github.com/apache/beam/blob/master/sdks/python/README.md) | | |||
There was a problem hiding this comment.
This is list of feature branches -- Python SDK like should be removed from here, not updated.
Regarding the README.md file -- they are not discoverable if they are deep in the structure, so they make little impact and it is hard to keep them up-to-date. Most important information should go to the top-level README, and everything else to the website under Documentation -> SDKs -> Python SDK. This is nicely formatted, searchable, visible, etc.
|
Thank you, PTAL. |
|
Refer to this link for build results (access rights to CI server needed): Jenkins built the site at commit id d8644dc with Jekyll and staged it here. Happy reviewing. Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again. |
|
Refer to this link for build results (access rights to CI server needed): |
|
LGTM. Merging. |
No description provided.