lanyuanxiaoyao/hudi
1
0
Fork 0
Code Activity

[HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes (#1195)

Browse Source 
* Add javadoc build command in README, links to javadoc plugin and rename profile.
* Make java version configurable in one place.
This commit is contained in:
Y Ethan Guo
2020-01-08 10:38:10 -08:00
committed by vinoth chandar
parent aba83876e7
commit 480fc7869d
3 changed files with 121 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -57,6 +57,12 @@ git clone https://github.com/apache/incubator-hudi.git && cd incubator-hudi
mvn clean package -DskipTests -DskipITs
```
To build the Javadoc for all Java and Scala classes:
```
# Javadoc generated under target/site/apidocs
mvn clean javadoc:aggregate -Pjavadocs
```
## Quickstart
Please visit [https://hudi.apache.org/quickstart.html](https://hudi.apache.org/quickstart.html) to quickly explore Hudi's capabilities using spark-shell.