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
[x] 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":
Subject is separated from body by a blank line
Subject is limited to 50 characters (not including Jira issue reference)
Subject does not end with a period
Subject uses the imperative mood ("add", not "adding")
Body wraps at 72 characters
Body explains "what" and "why", not "how"
Documentation
This is a README only change
[x] 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
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
Documentation
This is a README only change