Bug 1088648 - [Docs] [Change] [Admin] Procedures involving virtual machines must be generalized [UG]
Summary: [Docs] [Change] [Admin] Procedures involving virtual machines must be general...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.4.0
Hardware: Unspecified
OS: Unspecified
medium
unspecified
Target Milestone: ---
: ---
Assignee: Andrew Dahms
QA Contact: Lucy Bopf
URL:
Whiteboard:
Depends On: 1088650
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-04-16 23:11 UTC by Andrew Dahms
Modified: 2014-08-01 01:03 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-08-01 01:03:31 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Andrew Dahms 2014-04-16 23:11:18 UTC
There are many procedures involving virtual machines that are shared by both the Administration Guide and User Guide. While a number of topics have been created for these procedures, the opening line is different for the Administration Guide and User Guide. Standardization of this line would allow the topics to be used in both guides and in doing so promote reusability and ease of maintenance.

For example -

"Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list."

To -

"Click on the Virtual Machines tab and select a virtual machine."

Comment 1 Andrew Dahms 2014-04-16 23:38:47 UTC
Fixed in 7559, 24421, 30183, 7476, 25597, 30245, 7510, 7418, 12693, 25079, 14181.

Comment 2 Andrew Dahms 2014-04-28 01:00:35 UTC
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4/html-single/User_Guide/index.html#sect-Template_Tasks

What Changed
------------------------------
The following topics were revised to change the first line in each procedure from one telling the user to use a specific tab to select a virtual machine to a generalized 'Click the Virtual Machines tab and select a virtual machine' line so that they can be used in guides other than the User Guide if necessary.

Creating a Template [7559-632079]

Using Cloud-Init to Initialize a Virtual Machine [24421-632077]

Using Cloud-Init to Prepare a Template [30183-632078]

Creating a Virtual Machine [7476-632081]

Extending the Size of an Online Virtual Disk [25597-632085]

Adding a Watchdog Card to a Virtual machine [30245-632084]

Removing a Virtual Machine [7510-632086]

Creating Snapshots [7418-632089]

Cloning Snapshots [12693-632090]

Configuring Multiple Displays for Windows Virtual Machines [25079-632095]

Using USB Devices on a Red Hat Enterprise Linux Client [14181-632096]

NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Administration_Guide-3.4-en-US-3.4-23

Moving to ON_QA.

Comment 3 Lucy Bopf 2014-08-01 01:03:31 UTC
Peer reviewed.

The first line of each procedure has been generalized. The first 7 topics outlined in Comement #2 now appear live in the both the User and Administration Guides; the remaining 4 appear in the User Guide only.

VERIFIED.


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