Skip to content

[SPARK-51991] Add SparkConnect.md, GettingStarted.md and SparkSession.md #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

dongjoon-hyun
Copy link
Member

@dongjoon-hyun dongjoon-hyun commented May 3, 2025

What changes were proposed in this pull request?

This PR aims to add a library document.

  • SparkConnect.md
  • GettingStarted.md
  • SparkSession.md

Why are the changes needed?

This document will be served in Swift Package Index repository like the following.

Screenshot 2025-05-03 at 9 10 51 AM

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Manual review.

Was this patch authored or co-authored using generative AI tooling?

No.

@dongjoon-hyun dongjoon-hyun changed the title [SPARK-51991] Add GettingStarted.md and SparkSession.md [SPARK-51991] Add SparkConnect.md, GettingStarted.md and SparkSession.md May 3, 2025
@dongjoon-hyun
Copy link
Member Author

Thank you, @viirya !

@dongjoon-hyun
Copy link
Member Author

Merged to main.

@dongjoon-hyun dongjoon-hyun deleted the SPARK-51991 branch May 3, 2025 16:22
dongjoon-hyun added a commit that referenced this pull request May 4, 2025
…m docs

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

This PR aims mark `nodoc` to hide generated and internal classes from docs.

### Why are the changes needed?

Since #107, the documentation is visible here.
- https://swiftpackageindex.com/apache/spark-connect-swift/main/documentation/sparkconnect

We need to simplify the documentation to focus `Spark Connect for Swift` itself by hiding irrelevant information . For example, `Arrow`-related information will be removed eventually when we start to use the official `Apache Arrow` release.

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

No.

### How was this patch tested?

Manual review.

### Was this patch authored or co-authored using generative AI tooling?

No.

Closes #113 from dongjoon-hyun/SPARK-51997.

Authored-by: Dongjoon Hyun <dongjoon@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants