Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

[HIVEMALL-193] Implement a tool for generating a list of Hivemall UDFs #148

Closed
wants to merge 13 commits into from

Conversation

takuti
Copy link
Member

@takuti takuti commented Apr 23, 2018

What changes were proposed in this pull request?

Automatically generate a list of UDFs for:

Initial mock implementation: https://github.com/takuti/hivemalldoc

What type of PR is it?

Improvement, Documentation

What is the Jira issue?

https://issues.apache.org/jira/browse/HIVEMALL-193

How was this patch tested?

See output: https://gist.github.com/takuti/312d3a11bf85fc4044399d7e97a06f13

How to use this feature?

$ mvn clean package -Dskiptests=true -Dmaven.test.skip=true
$ mvn org.apache.hivemall:hivemall-docs:generate-funcs-list

Checklist

  • Did you apply source code formatter, i.e., mvn formatter:format, for your commit?

</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
Copy link
Member

@myui myui Apr 24, 2018

Choose a reason for hiding this comment

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

Instead of using shaded jar, it's better to use MOJO.

Goals such as mvn hivemall-docs:gen_func_list.

Copy link
Member Author

Choose a reason for hiding this comment

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

fb81564

Usage:

$ mvn org.apache.hivemall:hivemall-docs:generate-funcs-list

Lists of UDFs are written into target/funcs.md and target/generic_funcs.md

Copy link
Member

Choose a reason for hiding this comment

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

@takuti Why not directly update these files?

docs/gitbook/misc/funcs.md
docs/gitbook/misc/generic_funcs.md

Copy link
Member Author

Choose a reason for hiding this comment

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

Just in case, the generator defensively does so. If you feel directly over-writing docs/gitbook/* is fine, I can update so.

Copy link
Member

@myui myui Apr 24, 2018

Choose a reason for hiding this comment

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

I prefer directly updating them since it's intendedly updated by running mvn org.apache.hivemall:hivemall-docs:generate-funcs-list.

If you are using git, there are no problem for undo.

@takuti
Copy link
Member Author

takuti commented Apr 24, 2018

Now mvn org.apache.hivemall:hivemall-docs:generate-funcs-list automatically updates docs/gitbook/*

@asfgit asfgit closed this in 36fb839 Apr 25, 2018
@myui
Copy link
Member

myui commented Apr 25, 2018

LGTM. Merged! Thanks.

@takuti takuti deleted the HIVEMALL-193 branch April 25, 2018 08:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants