Final change - adding "marklogic-" as a prefix

Couple small fixes in the contributing guide too.

Author: rjrudin

CONTRIBUTING.md

@@ -257,15 +257,15 @@ are all synonyms):
 
     ./gradlew shadowJar
 
-This will produce an assembly jar at `./flux-cli/build/libs/flux-1.0.0-all.jar`.
+This will produce an assembly jar at `./flux-cli/build/libs/marklogic-flux-1.0.0-all.jar`.
 
 You can now run any CLI command via spark-submit. This is an example of previewing an import of files - change the value
 of `--path`, as an absolute path is needed, and of course change the value of `--master` to match that of your Spark
 cluster:
 
 ```
 $SPARK_HOME/bin/spark-submit --class com.marklogic.flux.spark.Submit \
---master spark://NYWHYC3G0W:7077 flux-cli/build/libs/flux-1.0-SNAPSHOT-all.jar \
+--master spark://NYWHYC3G0W:7077 flux-cli/build/libs/marklogic-flux-1.0.0-all.jar \
 import-files --path /Users/rudin/workspace/flux/flux-cli/src/test/resources/mixed-files \
 --connection-string "admin:admin@localhost:8000" \
 --preview 5 --preview-drop content
@@ -276,13 +276,13 @@ After spark-submit completes, you can refresh <http://localhost:8080> to see evi
 The assembly jar does not include the AWS SDK, as doing so would increase its size from about 8mb to close to 400mb.
 spark-submit allows for dependencies to be included via its `--packages` option. The following shows an example of
 previewing an import of files from an S3 bucket by including the AWS SDK as package dependencies (change the bucket name
-to something you can access :
+to something you can access):
 
 ```
 $SPARK_HOME/bin/spark-submit --class com.marklogic.flux.spark.Submit \
---packages org.apache.hadoop:hadoop-aws:3.3.6,org.apache.hadoop:hadoop-client:3.3.6 \
+--packages org.apache.hadoop:hadoop-aws:3.3.4,org.apache.hadoop:hadoop-client:3.3.4 \
 --master spark://NYWHYC3G0W:7077 \
-flux-cli/build/libs/flux-1.0-SNAPSHOT-all.jar \
+flux-cli/build/libs/marklogic-flux-1.0.0-all.jar \
 import-files --path "s3a://changeme/" \
 --connection-string "admin:admin@localhost:8000" \
 --s3-add-credentials \

build.gradle

@@ -30,7 +30,7 @@ task gettingStartedZip(type: Zip) {
     "on the GitHub release page."
   from "examples/getting-started"
   exclude "build", ".gradle", "gradle-*.properties", "flux", ".gitignore"
-  into "flux-getting-started-${version}"
-  archiveFileName = "flux-getting-started-${version}.zip"
+  into "marklogic-flux-getting-started-${version}"
+  archiveFileName = "marklogic-flux-getting-started-${version}.zip"
   destinationDirectory = file("build")
 }

docs/getting-started.md

@@ -15,18 +15,18 @@ This guide describes how to get started with Flux with some examples demonstrati
 ## Setup
 
 You can download the latest release of the Flux application zip from [the latest Flux release page](https://github.com/marklogic/flux/releases). 
-The Flux application zip is titled `flux-1.0.0.zip`. You can extract this zip to any location on your 
+The Flux application zip is titled `marklogic-flux-1.0.0.zip`. You can extract this zip to any location on your 
 filesystem that you prefer.
 
 ### Deploying the example application
 
 The examples in this guide, along with examples found throughout this documentation, depend on a small MarkLogic 
 application that can be deployed to your own instance of MarkLogic server. The application can be downloaded from 
 [the latest Flux release page](https://github.com/marklogic/flux/releases) in a zip titled 
-`flux-getting-started-1.0.0.zip`. To use Flux with this example application, perform the following steps:
+`marklogic-flux-getting-started-1.0.0.zip`. To use Flux with this example application, perform the following steps:
 
-1. Extract the `flux-getting-started-1.0.0.zip` file to any location on your local filesystem.
-2. Run `cd flux-getting-started-1.0.0` to change to the directory created by extracting the zip file.
+1. Extract the `marklogic-flux-getting-started-1.0.0.zip` file to any location on your local filesystem.
+2. Run `cd marklogic-flux-getting-started-1.0.0` to change to the directory created by extracting the zip file.
 3. Create a file named `gradle-local.properties` and add `mlPassword=your MarkLogic admin user password` to it.
 4. Examine the contents of the `gradle.properties` file to ensure that the value of `mlHost` points to your MarkLogic 
 server and that the value of `mlRestPort` is a port available for a new MarkLogic app server to use.
@@ -38,15 +38,15 @@ privileges for running the examples in this guide. Finally, the application incl
 [MarkLogic TDE template](https://docs.marklogic.com/guide/app-dev/TDE) that creates a view in MarkLogic for the purpose
 of demonstrating commands that utilize a [MarkLogic Optic query](https://docs.marklogic.com/guide/app-dev/OpticAPI).
 
-It is recommended to extract the Flux application zip into the `flux-getting-started-1.0.0` directory so that 
+It is recommended to extract the Flux application zip into the `marklogic-flux-getting-started-1.0.0` directory so that 
 you can easily execute the examples in this guide. After extracting the application zip, the directory should have a 
 structure similar to this (not all files may be shown):
 
 ```
-./flux-getting-started-1.0.0
+./marklogic-flux-getting-started-1.0.0
     build.gradle
     ./data
-    ./flux-1.0.0
+    ./marklogic-flux-1.0.0
     ./gradle
     gradle.properties
     gradlew
@@ -59,7 +59,7 @@ structure similar to this (not all files may be shown):
 You can run Flux without any options to see the list of available commands. If you are using Flux to run these examples, 
 first change your current directory to where you extract Flux:
 
-    cd flux-1.0.0
+    cd marklogic-flux-1.0.0
 
 And then run the Flux executable without any options:
 

docs/spark-integration.md

@@ -35,7 +35,7 @@ Flux integrates with [spark-submit](https://spark.apache.org/docs/latest/submitt
 submit a Flux command invocation to a remote Spark cluster. Every Flux command is a Spark application, and thus every
 Flux command, along with all of its option, can be invoked via `spark-submit`. 
 
-To use Flux with `spark-submit`, first download the `flux-1.0.0-all.jar` file from the 
+To use Flux with `spark-submit`, first download the `marklogic-flux-1.0.0-all.jar` file from the 
 [GitHub release page](https://github.com/marklogic/flux/releases/tag/1.0.0). This jar file includes Flux and all of 
 its dependencies, excluding those of Spark itself, which will be provided via the Spark cluster that you connect to 
 via `spark-submit`. 
@@ -46,7 +46,7 @@ The following shows a notional example of running the Flux `import-files` comman
 ```
 $SPARK_HOME/bin/spark-submit --class com.marklogic.flux.spark.Submit \
     --master spark://changeme:7077 \
-    flux-1.0.0-all.jar \
+    marklogic-flux-1.0.0-all.jar \
     import-files \
     --path path/to/data
     --connection-string user:password@host:8000

examples/getting-started/.gitignore

@@ -4,4 +4,4 @@ lib
 export
 nt
 flux
-
+marklogic-flux

flux-cli/build.gradle

@@ -94,7 +94,7 @@ updateJavadoc.dependsOn deleteJavadoc, javadoc, copyJavadoc
 
 distributions {
   main {
-    distributionBaseName = "flux"
+    distributionBaseName = "marklogic-flux"
   }
   applicationDistribution.from("..") {
     include "LICENSE"
@@ -212,7 +212,7 @@ sonar {
 // See https://imperceptiblethoughts.com/shadow/configuration/dependencies/ .
 shadowJar {
   configurations = [project.configurations.shadowDependencies]
-  archiveBaseName = "flux"
+  archiveBaseName = "marklogic-flux"
 }
 
 // Publishing setup - see https://docs.gradle.org/current/userguide/publishing_setup.html .