Bug 1886328 - [Test Day] misleading geo-rep reset-sync-time command syntax in admin doc
Summary: [Test Day] misleading geo-rep reset-sync-time command syntax in admin doc
Keywords:
Status: CLOSED EOL
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat Storage
Component: Documentation
Version: rhgs-3.5
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: RHGS 3.5.z Batch Update 3
Assignee: Nobody
QA Contact: Manisha Saini
URL:
Whiteboard:
Depends On:
Blocks: 1887323
TreeView+ depends on / blocked
 
Reported: 2020-10-08 08:18 UTC by Manisha Saini
Modified: 2023-11-25 05:27 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-11-24 03:23:01 UTC
Embargoed:


Attachments (Terms of Use)

Description Manisha Saini 2020-10-08 08:18:03 UTC
Describe the issue:
===================

Remove the brackets from "reset-sync-time" parameter from below command as it mislead the user with the syntax or either provide an example in same section to run the command


Currently-
----------
gluster volume geo-replication MASTER_VOL SLAVE_HOST::SLAVE_VOL delete [reset-sync-time]
----------


Changes need to be done-
----------

Approach 1: To directly mention the syntax as--->

To delete a geo-replication session, use the following command:
# gluster volume geo-replication MASTER_VOL SLAVE_HOST::SLAVE_VOL delete reset-sync-time

Approach 2: To first mention the syntax with explicit parameter and then example for same

gluster volume geo-replication MASTER_VOL SLAVE_HOST::SLAVE_VOL delete [reset-sync-time]

Eg : gluster volume geo-replication Volume1 storage.backup.com::slave-vol delete reset-sync-time

-----------


Describe the task you were trying to accomplish:
===============================================
Deleting geo-rep session



Document URL:
=============

https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.5/html-single/administration_guide/index?lb_target=preview#Stopping_a_Geo-replication_Session

   ---> 10.4.6. Deleting a Geo-replication Session


Additional information:

======================
On running the command mentioned in admin guide--

# gluster volume geo-replication master-vol dhcp35-8.lab.eng.blr.redhat.com::slave-vol delete [reset-sync-time]

Usage:
volume geo-replication [<MASTER-VOLNAME>] [<SLAVE-IP>]::[<SLAVE-VOLNAME>] {\
 create [[ssh-port n] [[no-verify] \
 | [push-pem]]] [force] \
 | start [force] \
 | stop [force] \
 | pause [force] \
 | resume [force] \
 | config [[[\!]<option>] [<value>]] \
 | status [detail] \
 | delete [reset-sync-time]}

Comment 2 Manisha Saini 2021-02-10 11:16:53 UTC
Master preview:
https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.5/html-single/administration_guide/index?lb_target=preview


Verified changes in the above link.Changes looks good to me.Moving this BZ to verified state.


Note You need to log in before you can comment on or make changes to this bug.