[BEAM-3252] Updating contributor's guide to reference Gradle.#414
[BEAM-3252] Updating contributor's guide to reference Gradle.#414youngoli wants to merge 7 commits intoapache:asf-sitefrom
Conversation
Removed as many references to maven or pom files under contribute as I could. There's still a few references in the Eclipse Tips file since I have no clue how to use Eclipse with Gradle and have yet to find someone who does. Also references in maturity-model in the dependency tree. It's not really possible to create a Gradle dependency tree that isn't hundreds of thousands of lines though, because each distinct configuration in each project has it's own dependencies so you end up creating hundreds of dependency trees, many of which are hundreds of lines long by themselves.
|
Note: I was making this PR unaware that @udim was working on an overlapping change in #412. The overlapping changes will probably need to be merged by someone. Also note: This change and other Maven->Gradle changes should probably go in a separate branch so the site doesn't mention Maven in some places and Gradle in others. |
lukecwik
left a comment
lukecwik
left a comment
There was a problem hiding this comment.
Made minor edits for updates.
src/contribute/intellij.md
Outdated
| * Store generated project files externally | ||
| * Use default gradle wrapper | ||
|
|
||
| This should result in a working Gradle project. Build the project by executing the "build" task in |
There was a problem hiding this comment.
I believe we should tell users to delegate build/test actions to gradle. We should tell users to do this as well, instructions are here: https://dzone.com/articles/using-idea-to-delegate-build-and-run-actions-to-gr
src/contribute/intellij.md
Outdated
| This should result in a working Gradle project. Build the project by executing the "build" task in | ||
| the root Gradle module. | ||
|
|
||
| ## Enable Annotation Processing |
There was a problem hiding this comment.
I don't believe we need this whole section.
There was a problem hiding this comment.
By this whole section do you mean the "Enable Annotation Processing" section?
There was a problem hiding this comment.
Yes, target folders refer to Maven.
Also, try out the quickstart manually using intellij in a new project.
There was a problem hiding this comment.
Ah. So does that mean there's no gradle version of those directories then if the solution is to remove the entire section?
Also yes, I'll do that. I already did so for the gradle setup directions, but I ignored the rest of the instructions (annotations, checkstyle, and codestyle).
There was a problem hiding this comment.
Based upon your current set of instructions for intellij, I don't believe we need anything additional for the annotation processing.
|
@aaltay / @udim For the Python SDK development in the contribution guide, should we prefer gradle since it automatically sets up the virtualenv. It seems like a lot less work for new contributors. There can be Python SDK advanced instructions, similar to how the intellij instructions exists which go through the virtualenv setup, ... |
|
My opinion is that, it is better to use gradle based python development in the contribution guide. It makes it uniform across the project and easy to get started. I would think that anyone doing heavy development on python will actually use virtualenv based setup. Let's keep them as an alternative (or advanced) option. |
Adding a step to the contributor's guide IntelliJ tip for setting up gradle describing how to delegate builds to gradle.
That section is outdated and reliant on Maven, so it can be removed.
|
@asfgit merge |
3 participants
Removed as many references to maven or pom files under contribute
as I could. There's still a few references in the Eclipse Tips file
since I have no clue how to use Eclipse with Gradle and have yet to
find someone who does.
Also references in maturity-model in the dependency tree. It's not
really possible to create a Gradle dependency tree that isn't hundreds
of thousands of lines though, because each distinct configuration in
each project has it's own dependencies so you end up creating hundreds
of dependency trees, many of which are hundreds of lines long by
themselves.