Merge remote-tracking branch 'origin/5.3'

README.md

@@ -21,3 +21,4 @@ Read-the-docs (https://readthedocs.org/) will build automatically, but
 it's nice to build locally for verification. Build using make:
 
     make html
+

doc/index.rst

@@ -47,7 +47,7 @@ is `available on github`_ in a separate project.
    reference/libraries/index
    reference/view-functions/index
    reference/query-language
-   reference/shell-scripts/index
+   reference/toolbox/index
    reference/javadoc
 
 .. toctree::

doc/operations/backup.rst

@@ -55,9 +55,9 @@ The snapshot rest-service accepts a JSON in this format:
 
 A snapshot of the given repository will be created for later retrieval. Each subsequent snapshot will store the changes between this snapshot
 and the last snapshot of the given repository. This means that only changed data are stored when doing subsequent snapshots. The snapshots
-will be stored in ``$XP_HOME/snapshots``. A name of the snapshot will be given at snapshot-time, and returned in the snapshot-result.
+will be stored in ``$XP_HOME/data/snapshot``. A name of the snapshot will be given at snapshot-time, and returned in the snapshot-result.
 
-To ease the process, we have provided a :ref:`shell-scripts-snapshot` tool.
+To ease the process, we have provided a :ref:`toolbox-snapshot` tool.
 
 
 Restore
@@ -73,7 +73,7 @@ The restore rest-service accepts a JSON in this format:
   }
 
 The indices will be closed for the duration of a restore operation, meaning that no request will be accepted while the restore in running.
-To ease the process, we have provided a :ref:`shell-scripts-restore` tool.
+To ease the process, we have provided a :ref:`toolbox-restore` tool.
 
 .. WARNING::
 
@@ -94,4 +94,4 @@ The delete rest-service accepts a JSON in this format:
   }
 
 Deletes either all snapshots before timestamp, or given snapshots by name. To ease the process, we have provided a
-:ref:`shell-scripts-deleteSnapshots` tool.
+:ref:`toolbox-delete-snapshots` tool.

doc/operations/export.rst

@@ -4,9 +4,7 @@ Export and Import
 =================
 
 Exporting and importing data in your Enonic XP installation is useful both for securing data and migrating between installations.
-
-Enonic XP ships with a set of :ref:`shell-scripts` to ease the operation of exporting and importing data from the system.
-The provided scripts can be found in the ``$XP_INSTALL/tools`` folder.
+Enonic XP ships with a set of :ref:`toolbox` to ease the operation of exporting and importing data from the system.
 
 .. CAUTION::
 
@@ -17,8 +15,9 @@ The provided scripts can be found in the ``$XP_INSTALL/tools`` folder.
 Export
 ------
 
-The export operation will extract data for a given content URL and store it as XML in the
-specified directory. The REST service for export is found at the following URL::
+The export operation will extract data for a given content URL and store it as XML
+in a sub-folder under ``$XP_HOME/data/export``.
+The REST service for export is found at the following URL::
 
   http://<host>:<port>/admin/rest/export/export
 
@@ -28,12 +27,12 @@ The export REST service accepts a JSON in this format:
 
   {
     "sourceRepoPath": "<source-repo-path>",
-    "targetDirectory": "<absolute-path-to-directory-on-server>",
+    "exportName": "<name>",
     "importWithIds": <true|false>,
     "dryRun": <true|false>
   }
 
-To ease the process, we have provided an :ref:`shell-scripts-export` tool.
+To ease the process, we have provided an :ref:`toolbox-export` tool.
 
 
 Import
@@ -49,13 +48,13 @@ The import REST service accepts a JSON in this format:
 .. code-block:: json
 
   {
-    "sourceDirectory": "<absolute-path-to-source-directory-on-server>",
+    "exportName": "<name>",
     "targetRepoPath": "<target-repo-path>",
     "importWithIds": <true|false>,
     "dryRun": <true|false>
   }
 
-To ease the process, we have provided an :ref:`shell-scripts-import` tool.
+To ease the process, we have provided an :ref:`toolbox-import` tool.
 
 
 Export data structure
@@ -67,10 +66,10 @@ Let's look at how this works. The following structure will be exported:
 
 Run the export command::
 
-  $ ./export.sh -u su:password -s cms-repo:draft:/ -t /tmp/myexport \
+  $ ./export.sh -u su:password -s cms-repo:draft:/ -t myexport \
     -n -i false
 
-Below is the resulting structure in the export folder ``/tmp/myexport``::
+Below is the resulting structure in the export folder ``$XP_HOME/data/export/myexport``::
 
   ./content
   ./content/_
@@ -129,7 +128,7 @@ It is possible to make manual changes to the exported data before importing.
 
 Using the above export as an example, the ``demo-site`` displayName can be changed to something more suitable::
 
-  /tmp/myExport $ vi content/demo-site/_/node.xml
+  myExport $ vi content/demo-site/_/node.xml
 
   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <node xmlns="urn:enonic:xp:export:1.0">
@@ -144,7 +143,7 @@ Using the above export as an example, the ``demo-site`` displayName can be chang
 
 After some data has been changed, it can be imported again::
 
-  $ ./import.sh -u su:password -s /Users/rmy/tmp/myExport -t cms-repo:draft:/
+  $ ./import.sh -u su:password -s myExport -t cms-repo:draft:/
 
 .. image:: images/import-result.png
 

doc/operations/folders.rst

@@ -11,7 +11,7 @@ The unpacked Enonic XP distribution will have the following structure::
      |- logs/
    |- lib/
    |- system/
-   |- tools/
+   |- toolbox/
    |- repo/
    |- data/
 
@@ -39,9 +39,8 @@ lib/
 system/
   System OSGi bundles are placed here.
 
-tools/
-  Scripts for misc operational activities like backup and export. See
-  :ref:`shell-scripts`.
+toolbox/
+  Command-line interface tool to manage the server. See :ref:`toolbox`.
 
 repo/
   Repository data (blobs and indexes).