mocobeta commented on code in PR #811:
URL: https://github.com/apache/lucene/pull/811#discussion_r850322876


##########
help/workflow.txt:
##########
@@ -25,11 +25,22 @@ Assemble a single module's JAR (here for lucene-core):
 gradlew -p lucene/core assemble
 ls lucene/core/build/libs
 
+Assemble all JARs:
+gradlew assemble
+
 Create all distributable packages, POMs, etc. and create a
 local maven repository for inspection:
 gradlew mavenLocal
 ls -R build/maven-local/
 
+Assemble Javdocs on a module:

Review Comment:
   > This is a general question on where to explain how gradle works (-p 
command) and whether this document should provide ready-to-use commands doing 
things or an explanation how to assemble those commands from scratch. 
   
   To me, a list of ready-to-use commands would be sufficient for this help 
document; here I'd give priority to brevity over detailed explanations. The 
usage of `-p` would be easily inferred from the examples, and I think 
developers who need more information about Gradle can always refer to the 
Gradle's documentation or other resources (just as I do).
   Maybe I'm not the right person to give an opinion on documentation for 
beginners... but I guess readers of this guide are experienced Java developers 
anyway?



-- 
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.

To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to