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: Update README.md with system diagram #148

Merged
merged 1 commit into from
Mar 1, 2024
Merged

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Mar 1, 2024

Which issue does this PR close?

Closes #.

Rationale for this change

A high level system diagram often helps people quickly understand what a project is and how it relates to other proejects.

@sunchao made a nice diagram for how Comet and Spark relate to each other for the blog post we are working on in apache/arrow-site#479 / apache/arrow-site#479 (comment) and I think that image would be valuable in the main README as well

What changes are included in this PR?

  1. Add diagram
  2. Update README.md to include diagram and some introductory text

How are these changes tested?

You can see how it renders here: https://github.com/alamb/arrow-datafusion-comet/tree/alamb/docs

Screenshot 2024-03-01 at 3 41 50 PM

@sunchao sunchao changed the title Minor: Update README.md with system diagram minor: Update README.md with system diagram Mar 1, 2024
Copy link
Member

@sunchao sunchao left a comment

Choose a reason for hiding this comment

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

LGTM

@sunchao sunchao merged commit 1f53e25 into apache:main Mar 1, 2024
@sunchao
Copy link
Member

sunchao commented Mar 1, 2024

Merged, thanks @alamb !

Copy link
Member

@viirya viirya left a comment

Choose a reason for hiding this comment

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

Looks good to me. 👍

@alamb alamb deleted the alamb/docs branch March 2, 2024 11:33
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.

3 participants