Red Hat Bugzilla – Bug 1477750
[HCI] Clarify wording in Configuring 'Geo-replication for Disaster Recovery'
Last modified: 2017-08-17 07:16:28 EDT
Document URL: https://access.redhat.com/documentation/en-us/red_hat_hyperconverged_infrastructure/1.0/html-single/maintaining_red_hat_hyperconverged_infrastructure/#configuring_geo_replication_for_disaster_recovery
Section Number and Name: 3.1.1 CONFIGURING GEO-REPLICATION FOR DISASTER RECOVERY - Before you Begin
Describe the issue:
"Prepare a remote backup volume to hold the geo-replicated copy of your local volume." <-- 'backup volume' please specify if this is the volume on the master or the slave/ROBO POD
"Ensure that the volume you want to back up has shared storage enabled." <-- 'the volume' please specify if this is the volume on the master or the slave/ROBO POD
"Ensure that your remote backup volume has sharding enabled." <-- "remote backup volume" please specify if this is the volume on the master or the slave/ROBO POD
Suggestions for improvement:
"Prepare a remote backup volume, located on the slave/ROBO POD, to hold the geo-replicated copy of your local volume located on the master."
"Ensure that the volume you want to back up has shared storage enabled."
"Ensure that your remote backup volume, located on the slave/ ROBO POD has sharding enabled."
Keeping this very specific will minimize confusion for customers
the phrase ' located on the slave/ ROBO POD' could either be included with commas, parentheses or general rewording
Rewording this whole section to specify where each volume is located explicitly will do a lot to keep the user from getting confused.
Also explicitly stating where to execute the commands in the section feels needed as well. As of now there's no mention of a statement like "Run the following command on one machine that is in the master group of machines" or any indication if any commands need to be run on multiple systems or just one.