Skip to content

[SPARK-40993][CONNECT][PYTHON][DOCS] Migrate markdown style README to PySpark Development Documentation #38477

Closed
amaliujia wants to merge 2 commits intoapache:masterfrom
amaliujia:SPARK-40993
Closed

[SPARK-40993][CONNECT][PYTHON][DOCS] Migrate markdown style README to PySpark Development Documentation #38477
amaliujia wants to merge 2 commits intoapache:masterfrom
amaliujia:SPARK-40993

Conversation

@amaliujia
Copy link
Contributor

What changes were proposed in this pull request?

This PR consolidates the development facing documentation of Spark Connect Python client into existing PySpark development doc (more specifically: python/docs/developmement/testing.rst).

Why are the changes needed?

Improve development documentation.

Does this PR introduce any user-facing change?

No

How was this patch tested?

Documentation check script.

@github-actions github-actions bot added the PYTHON label Nov 2, 2022
@amaliujia
Copy link
Contributor Author

cc @HyukjinKwon @grundprinzip

HyukjinKwon
HyukjinKwon previously approved these changes Nov 2, 2022
Copy link
Member

@HyukjinKwon HyukjinKwon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from a cursory look. Thanks for doing this.

cc @itholic mind double checking if anything is broken or inconsistent?

@HyukjinKwon HyukjinKwon changed the title [SPARK-40993][CONNECT]PYTHON[DOCS] Migrate markdown style README to PySpark Development Documentation [SPARK-40993][CONNECT][PYTHON][DOCS] Migrate markdown style README to PySpark Development Documentation Nov 2, 2022
@grundprinzip
Copy link
Contributor

Can we maybe hold this off until we have a decision if the Python client should be directly embedded in the PySpark code or extracted to its own module / artifact?

@HyukjinKwon
Copy link
Member

Yeah, I am fine with that.

@HyukjinKwon HyukjinKwon dismissed their stale review November 2, 2022 09:00

Dismissed

@itholic
Copy link
Contributor

itholic commented Nov 2, 2022

Looks good, and I'm also fine with.

@AmplabJenkins
Copy link

Can one of the admins verify this patch?

@HyukjinKwon
Copy link
Member

Fixed in #38470 for now.

Per #38477 (comment), let me close this for now.

@HyukjinKwon
Copy link
Member

Sicen we're going to package together, let's migrate this docs too. cc @zhengruifeng too

HyukjinKwon added a commit that referenced this pull request Jan 2, 2023
…and script to dev/ and Python documentation

### What changes were proposed in this pull request?

This PR takes over #39211 and #38477 that proposes:

- Move `connector/connect/dev/generate_protos.sh` → `dev/generate_protos.sh` to be consistent with other places
- Move Python-specific development guides into `python/docs/source/development/testing.rst`

### Why are the changes needed?

To keep the project structure and documentation consistent.

### Does this PR introduce _any_ user-facing change?

Python-specific development guides for Spark Connect will be added in https://spark.apache.org/docs/latest/api/python/development/testing.html.

### How was this patch tested?

I manually tested:

```
./dev/generate_protos.sh
./dev/check-codegen-python.py
```

I also manually verified the Python documentation.

Closes #39338 from HyukjinKwon/SPARK-41705.

Lead-authored-by: Hyukjin Kwon <gurwls223@apache.org>
Co-authored-by: Ted Yu <yuzhihong@gmail.com>
Co-authored-by: Rui Wang <rui.wang@databricks.com>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants