Skip to content
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

[MINOR] Make readme easier to follow #18

Closed
wants to merge 2 commits into from

Conversation

MrPowers
Copy link
Contributor

What changes were proposed in this pull request?

Update the README to make it easier to follow.

Why are the changes needed?

I tried to get spark-connect-go running locally and it was a little confusing. This new layout should make the setup steps a lot clearer.

Does this PR introduce any user-facing change?

Just updates the README.

How was this patch tested?

N/A.

@nkarpov
Copy link

nkarpov commented Apr 10, 2024

👍 nice I like it. I got tripped up bouncing between readme & quick start as a newbie.

README.md Outdated

## Spark Connect Go Application Example
2. Start the Spark Connect server with the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
2. Start the Spark Connect server with the following command:
2. Start the Spark Connect server with the following command (make sure to use a package version that matches your Spark distribution):

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@grundprinzip - updated this language, good suggestion.

Copy link
Contributor

@grundprinzip grundprinzip left a comment

Choose a reason for hiding this comment

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

Just a minor tweak.

@HyukjinKwon HyukjinKwon changed the title make readme easier to follow [MINOR] Make readme easier to follow Apr 11, 2024
@HyukjinKwon
Copy link
Member

Merged to master.

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.

4 participants