NIFI-8738 Update User Guide with Import and Export Flow from the UI
Signed-off-by: Pierre Villard <pierre.villard.fr@gmail.com>
This closes #5470.
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png
index 29a52dd..a67acf8 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/export_version.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/export_version.png
new file mode 100644
index 0000000..d6aa3c0
--- /dev/null
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/export_version.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/export_version_action.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/export_version_action.png
new file mode 100644
index 0000000..7dc03cf
--- /dev/null
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/export_version_action.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png
index ece10bd..15fa5c7 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png
index 5ae40a9..acee68c 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png
index 491f4d3..6010bb6 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_all.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_all.png
index 0faef8f..b189b71 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_all.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_all.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png
index 5d53d73..aea9307 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png
index 517a762..d8b9f0c 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_flow.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_flow.png
new file mode 100644
index 0000000..43d4880
--- /dev/null
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_flow.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_flow_button.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_flow_button.png
new file mode 100644
index 0000000..8b4bb2a
--- /dev/null
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_flow_button.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_version.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_version.png
new file mode 100644
index 0000000..81b2070
--- /dev/null
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_version.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_version_action.png b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_version_action.png
new file mode 100644
index 0000000..8cfbe85
--- /dev/null
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/import_new_version_action.png
Binary files differ
diff --git a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
index 69c79da..67fe5a4 100644
--- a/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
+++ b/nifi-registry/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
@@ -96,14 +96,14 @@
image::bucket_menu.png["Bucket Menu"]
-Click on a flow to see its Description and Change Log:
+Click on a flow to see its Bucket Identifier, Flow Identifier, Description and Change Log:
image::flow_change_log.png["Flow Change Log"]
The Change Log includes all versions that were saved for a flow. Clicking on the version reveals details about when the version was saved, which user committed the save, and any comments entered by the user.
==== Sorting & Filtering Flows
-Flows can be sorted alphabetically by Name (ascending or descending) or by Update (newest or oldest) using the drop-down at the top right of the UI.
+Flows can be sorted alphabetically by Name (ascending or descending), by Update (newest or oldest) or by Type (ascending or descending) using the Sort By drop-down.
image::flows_sort_menu.png["Flows Sort Menu"]
@@ -114,16 +114,60 @@
* flow ID
* bucket name
* bucket ID
+* type
Here is an example filtering by flow name:
image::flows_filter_by_name.png["Flows Filter By Name"]
+=== Import a Flow
+To import a flow into the registry:
+
+1. Click on the "Import New Flow" button. A bucket must exist for this button to be visible.
++
+image::import_new_flow_button.png["Import New Flow button"]
++
+2. Enter a unique flow name and a flow description if desired.
+3. Select the destination bucket.
+4. Drop or select a flow definition file.
++
+image::import_new_flow.png["Import New Flow dialog"]
++
+5. Select "Import".
+
+=== Import New Version of a Flow
+To import a new version of a flow:
+
+1. Click on the flow to see its details.
+2. Select the "Actions" drop-down and click the "Import new flow" menu option.
++
+image::import_new_version_action.png["Import New Version Action"]
++
+3. Drop or select a flow definition file.
++
+image::import_new_version.png["Import New Version dialog"]
++
+4. Select "Import".
+
+=== Export a Flow Version
+To export a version of a flow:
+
+1. Click on the flow to see its details.
+2. Select the "Actions" drop-down and click the "Export version" menu option.
++
+image::export_version_action.png["Export Version Action"]
++
+3. Choose the version of the flow to export. By default, the latest version is selected.
++
+image::export_version.png["Export Version dialog"]
++
+4. Select "Export".
+
=== Delete a Flow
To delete a flow from the registry:
1. Click on the flow to see its details.
-2. Select the "Actions" drop-down and click the "Delete" menu option.
+2. Select the "Actions" drop-down and click the "Delete flow" menu option.
+
image::flow_delete_action.png["Flow Delete Action"]
3. Select "Delete" to confirm.
