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

PARQUET-2479: Update README with link to parquet website, clarify contents #243

Merged
merged 1 commit into from
May 21, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented May 19, 2024

https://issues.apache.org/jira/browse/PARQUET-2479

As part of clarifying and improving the public communication about Parquet, I think we should also link parquet-format to the parquet.apache.org website

Also, the text in the format repo's readme is somewhat unclear on what is in the repo and how it related to other projects, so I clarified that as well

You can see the rendered version of the README here:
https://github.com/alamb/parquet-format/tree/alamb/doc_link_readme?tab=readme-ov-file#parquet-

Jira

Commits

  • My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

This is a README only change

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain Javadoc that explain what it does


Parquet metadata is encoded using Apache Thrift.
Apache Parquet is an open source, column-oriented data file format
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the same wording from apache/parquet-site#59

Copy link
Contributor

@vinooganesh vinooganesh left a comment

Choose a reason for hiding this comment

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

+1, looks good to me

Copy link
Member

@wgtmac wgtmac left a comment

Choose a reason for hiding this comment

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

+1

@wgtmac wgtmac merged commit dca2f42 into apache:master May 21, 2024
6 checks passed
@alamb alamb deleted the alamb/doc_link_readme branch May 21, 2024 16:38
@alamb
Copy link
Contributor Author

alamb commented May 21, 2024

Thank you for the review @wgtmac and @vinooganesh

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