From a93d3308bc0db68acf2c8eb365b60e3d41e8eab2 Mon Sep 17 00:00:00 2001
From: Lucille Delisle <lucille.delisle@epfl.ch>
Date: Fri, 18 Jun 2021 11:08:48 +0200
Subject: [PATCH] change doc for ftp_upload_dir/site

---
 doc/source/admin/galaxy_options.rst         | 35 +++++++++++----------
 lib/galaxy/config/sample/galaxy.yml.sample  | 15 ++++-----
 lib/galaxy/webapps/galaxy/config_schema.yml | 12 +++----
 3 files changed, 32 insertions(+), 30 deletions(-)

diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst
index 895ad01274b..82e763823c5 100644
--- a/doc/source/admin/galaxy_options.rst
+++ b/doc/source/admin/galaxy_options.rst
@@ -3652,28 +3652,29 @@
 :Type: str
 
 
-~~~~~~~~~~~~~~~~~~
-``ftp_upload_dir``
-~~~~~~~~~~~~~~~~~~
-
-:Description:
-    Enable Galaxy's "Upload via FTP" interface.  You'll need to
-    install and configure an FTP server (we've used ProFTPd since it
-    can use Galaxy's database for authentication) and set the
-    following two options. This should point to a directory containing
-    subdirectories matching users' identifier (defaults to e-mail),
-    where Galaxy will look for files.
-:Default: ``None``
-:Type: str
-
-
 ~~~~~~~~~~~~~~~~~~~
 ``ftp_upload_site``
 ~~~~~~~~~~~~~~~~~~~
 
 :Description:
-    This should be the hostname of your FTP server, which will be
-    provided to users in the help text.
+    Enable Galaxy's "Upload via FTP" interface.  You'll need to
+    install and configure an FTP server (we've used ProFTPd since it
+    can use Galaxy's database for authentication) and set the
+    following two options. This will be provided to users in the help
+    text as 'log in to the FTP server at '. Thus, it should be the
+    hostname of your FTP server.
+:Default: ``None``
+:Type: str
+
+
+~~~~~~~~~~~~~~~~~~
+``ftp_upload_dir``
+~~~~~~~~~~~~~~~~~~
+
+:Description:
+    This should point to a directory containing subdirectories
+    matching users' identifier (defaults to e-mail), where Galaxy will
+    look for files.
 :Default: ``None``
 :Type: str
 
diff --git a/lib/galaxy/config/sample/galaxy.yml.sample b/lib/galaxy/config/sample/galaxy.yml.sample
index ae2da998746..f395ac23232 100644
--- a/lib/galaxy/config/sample/galaxy.yml.sample
+++ b/lib/galaxy/config/sample/galaxy.yml.sample
@@ -1809,15 +1809,16 @@ galaxy:
   # Enable Galaxy's "Upload via FTP" interface.  You'll need to install
   # and configure an FTP server (we've used ProFTPd since it can use
   # Galaxy's database for authentication) and set the following two
-  # options. This should point to a directory containing subdirectories
-  # matching users' identifier (defaults to e-mail), where Galaxy will
-  # look for files.
-  #ftp_upload_dir: null
-
-  # This should be the hostname of your FTP server, which will be
-  # provided to users in the help text.
+  # options. This will be provided to users in the help text as 'log in
+  # to the FTP server at '. Thus, it should be the hostname of your FTP
+  # server.
   #ftp_upload_site: null
 
+  # This should point to a directory containing subdirectories matching
+  # users' identifier (defaults to e-mail), where Galaxy will look for
+  # files.
+  #ftp_upload_dir: null
+
   # User attribute to use as subdirectory in calculating default
   # ftp_upload_dir pattern. By default this will be email so a user's
   # FTP upload directory will be ${ftp_upload_dir}/${user.email}. Can
diff --git a/lib/galaxy/webapps/galaxy/config_schema.yml b/lib/galaxy/webapps/galaxy/config_schema.yml
index c8540a33011..1b50cd14898 100644
--- a/lib/galaxy/webapps/galaxy/config_schema.yml
+++ b/lib/galaxy/webapps/galaxy/config_schema.yml
@@ -2659,22 +2659,22 @@ mapping:
         desc: |
           The URL to the myExperiment instance being used (omit scheme but include port).
 
-      ftp_upload_dir:
+      ftp_upload_site:
         type: str
         required: false
         desc: |
           Enable Galaxy's "Upload via FTP" interface.  You'll need to install and
           configure an FTP server (we've used ProFTPd since it can use Galaxy's
           database for authentication) and set the following two options.
-          This should point to a directory containing subdirectories matching users'
-          identifier (defaults to e-mail), where Galaxy will look for files.
+          This will be provided to users in the help text as 'log in to the FTP
+          server at '. Thus, it should be the hostname of your FTP server.
 
-      ftp_upload_site:
+      ftp_upload_dir:
         type: str
         required: false
         desc: |
-          This should be the hostname of your FTP server, which will be provided to
-          users in the help text.
+          This should point to a directory containing subdirectories matching users'
+          identifier (defaults to e-mail), where Galaxy will look for files.
 
       ftp_upload_dir_identifier:
         type: str