Merge pull request #304 from marklogic/feature/doc-fixes

Small doc fixes

Author: rjrudin

docs/export/export-archives.md

@@ -132,7 +132,7 @@ You can specify an alternate encoding when exporting archives via the `--encodin
 {% tabs log %}
 {% tab log Unix %}
 ```
-./bin/flux export-archives \
+./bin/flux export-archive-files \
     --connection-string "flux-example-user:password@localhost:8004" \
     --collections example \
     --path destination \
@@ -141,7 +141,7 @@ You can specify an alternate encoding when exporting archives via the `--encodin
 {% endtab %}
 {% tab log Windows %}
 ```
-bin\flux export-archives ^
+bin\flux export-archive-files ^
     --connection-string "flux-example-user:password@localhost:8004" ^
     --collections example ^
     --path destination ^

docs/import/import-files/archives.md

@@ -142,3 +142,14 @@ will result in a URI of `/my%20file.json`. This is due to an
 [issue in the MarkLogic REST API endpoint](https://docs.marklogic.com/REST/PUT/v1/documents) that will be resolved in
 a future server release. 
 
+## Common errors
+
+If you use Flux 1.0.x to import an archive created by Flux 1.1.x or higher, you may receive an error containing the
+following message:
+
+```
+com.marklogic.spark: Could not find metadata entry for entry
+```
+
+To solve this, you should use Flux 1.1.0 or higher to import the archive. Flux 1.1.0 and higher can also import 
+archives created by Flux 1.0.x. 

examples/client-project/build.gradle

@@ -32,19 +32,22 @@ dependencies {
 }
 
 tasks.register("runApp", JavaExec) {
-  description = "Verify that the example program can be compiled and run with flux-api as a dependency."
+  description = "Verify that the example program can be compiled and run with flux-api as a dependency. " +
+    "Requires using Java 11."
   mainClass = "org.example.App"
   classpath = sourceSets.main.runtimeClasspath
 }
 
 tasks.register("runViaCustomTask") {
-  description = "Demonstrate how the Flux API can be used via a custom Gradle task."
+  description = "Demonstrate how the Flux API can be used via a custom Gradle task. " +
+    "Depends on the example application used in the Getting Started guide. " +
+    "Requires using Java 11. "
   doLast {
     Flux.importGenericFiles()
       .from("../../flux-cli/src/test/resources/mixed-files")
-      .connectionString("flux-test-user:password@localhost:8003")
+      .connectionString("flux-example-user:password@localhost:8004")
       .to({
-        it.permissionsString("flux-test-role,read,flux-test-role,update")
+        it.permissionsString("flux-example-role,read,flux-example-role,update")
           .collections("client-files")
       })
       .execute()

examples/client-project/src/main/java/org/example/App.java

@@ -5,14 +5,14 @@
 public class App {
 
     public static void main(String[] args) {
-        // Currently depends on flux test-app.
+        // Depends on the example application created in the Getting Started guide.
         Flux.importGenericFiles()
-            .connectionString("flux-test-user:password@localhost:8003")
+            .connectionString("flux-example-user:password@localhost:8004")
             .from(options -> options
                 .paths("../../flux-cli/src/test/resources/mixed-files"))
             .to(options -> options
                 .collections("client-files")
-                .permissionsString("flux-test-role,read,flux-test-role,update"))
+                .permissionsString("flux-example-role,read,flux-example-role,update"))
             .execute();
     }
 }