[
https://issues.apache.org/jira/browse/PARQUET-1826?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17075956#comment-17075956
]
ASF GitHub Bot commented on PARQUET-1826:
-----------------------------------------
garawalid commented on pull request #781: PARQUET-1826: Document Hadoop
configuration options
URL: https://github.com/apache/parquet-mr/pull/781
Make sure you have checked _all_ steps below.
### Jira
- [ ] My PR addresses the following [Parquet
Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references
them in the PR title. For example, "PARQUET-1234: My Parquet PR"
- https://issues.apache.org/jira/browse/PARQUET-XXX
- In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Tests
- [ ] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
### 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](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [ ] 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
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Document hadoop configuration options
> -------------------------------------
>
> Key: PARQUET-1826
> URL: https://issues.apache.org/jira/browse/PARQUET-1826
> Project: Parquet
> Issue Type: Improvement
> Components: parquet-mr
> Reporter: Gabor Szadovszky
> Assignee: Walid Gara
> Priority: Major
> Labels: pull-request-available
>
> The currently available hadoop configuration options is not documented
> properly. The only documentation we have is the javadoc comment and the
> implementation ofÂ
> [ParquetOutputFormat|https://github.com/apache/parquet-mr/blob/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/ParquetOutputFormat.java].
> We shall investigate all the possible options and their usage/default values
> and document them properly in a way that it is easily accessible by our users.
> I would suggest creating a `README.md` file in the sub-module
> [parquet-hadoop|https://github.com/apache/parquet-mr/tree/master/parquet-hadoop]
> that would describe the purpose of the module and would have a section that
> lists the possible hadoop configuration options. (Later on we shall extend
> this document with other descriptions about the purpose and usage of our
> library in the hadoop ecosystem. These efforts shall be covered by other
> jiras.)
> By adding the description to the source code it would be easy to extend it by
> the new features we implement so it will be up-to-date for every release.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
