Update documentation to the new name of the sync-groups tool.

refs #12018

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <wvandewege@veritasgenetics.com>

diff --git a/doc/_config.yml b/doc/_config.yml
index e8a899c004c1c257ee05d36d757ac42644eca10a..7b992d6c9453ec87f43dd80fe044c94da2ad256b 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -74,7 +74,7 @@ navbar:
       - user/topics/run-command.html.textile.liquid
       - user/reference/job-pipeline-ref.html.textile.liquid
       - user/examples/crunch-examples.html.textile.liquid
-      - user/topics/arv-sync-groups.html.textile.liquid
+      - user/topics/arvados-sync-groups.html.textile.liquid
     - Query the metadata database:
       - user/topics/tutorial-trait-search.html.textile.liquid
     - Arvados License:

diff --git a/doc/user/topics/arv-sync-groups.html.textile.liquid b/doc/user/topics/arvados-sync-groups.html.textile.liquid
similarity index 77%
rename from doc/user/topics/arv-sync-groups.html.textile.liquid
rename to doc/user/topics/arvados-sync-groups.html.textile.liquid
index e2a42c8954f2f300b01012b265e73265e0011efd..c9f74b5aa840deb25cd7557805609eca8200fb33 100644 (file)
--- a/doc/user/topics/arv-sync-groups.html.textile.liquid
+++ b/doc/user/topics/arvados-sync-groups.html.textile.liquid
@@ -1,7 +1,7 @@
 ---
 layout: default
 navsection: userguide
-title: "Using arv-sync-groups"
+title: "Using arvados-sync-groups"
 ...
 {% comment %}
 Copyright (C) The Arvados Authors. All rights reserved.
@@ -9,9 +9,9 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-The @arv-sync-groups@ tool allows to synchronize remote groups into Arvados from an external source.
+The @arvados-sync-groups@ tool allows to synchronize remote groups into Arvados from an external source.
 
-h1. Using arv-sync-groups
+h1. Using arvados-sync-groups
 
 This tool reads a CSV (comma-separated values) file having information about external groups and their members. When running it for the first time, it'll create a special group named 'Externally synchronized groups' meant to be the parent of all the remote groups.
 
@@ -22,7 +22,7 @@ Users can be identified by their email address or username: the tool will check
 This tool is designed to be run periodically reading a file created by a remote auth system (ie: LDAP) dump script, applying what's included on the file as the source of truth.
 
 
-bq. NOTE: @arv-sync-groups@ needs to perform several administrative tasks on Arvados, so must be run using a superuser token
+bq. NOTE: @arvados-sync-groups@ needs to perform several administrative tasks on Arvados, so must be run using a superuser token
 
 h2. Options
 
@@ -41,13 +41,13 @@ h2. Examples
 To sync groups using the username to identify every account, reading from some @external_groups.csv@ file, the command should be called as follows:
 
 <notextile>
-<pre><code>~$ <span class="userinput">arv-sync-groups --user-id username /path/to/external_groups.csv </span>
+<pre><code>~$ <span class="userinput">arvados-sync-groups --user-id username /path/to/external_groups.csv </span>
 </code></pre>
 </notextile>
 
 If you want to use a specific preexisting group as the parent of all the remote groups, you can do it this way:
 
 <notextile>
-<pre><code>~$ <span class="userinput">arv-sync-groups --parent-group-uuid &lt;preexisting group UUID&gt; --user-id username /path/to/external_groups.csv </span>
+<pre><code>~$ <span class="userinput">arvados-sync-groups --parent-group-uuid &lt;preexisting group UUID&gt; --user-id username /path/to/external_groups.csv </span>
 </code></pre>
 </notextile>