[Kimchi-devel] [PATCH] Changes to help
Adam King
rak at linux.vnet.ibm.com
Fri Mar 14 19:27:48 UTC 2014
Reviewed-by: Adam King <rak at linux.vnet.ibm.com>
On 03/14/2014 11:22 AM, Kersten Richter wrote:
> Added information for software updates, adding storage device, and replacing contents of CDROM. Plus a couple of clean up things.
>
> Signed-off-by: Kersten Richter <kersten at us.ibm.com>
> ---
> ui/pages/help/guests.dita | 83 ++++++++++++++++++++++++++++++------------
> ui/pages/help/host.dita | 44 +++++++++++++----------
> ui/pages/help/templates.dita | 18 +++++-----
> 3 files changed, 93 insertions(+), 52 deletions(-)
>
> diff --git a/ui/pages/help/guests.dita b/ui/pages/help/guests.dita
> index bae98bb..0456bbb 100644
> --- a/ui/pages/help/guests.dita
> +++ b/ui/pages/help/guests.dita
> @@ -23,26 +23,28 @@ KVM virtual machines.</shortdesc>
> <dd>Network input/output transmission rate in KB per seconds.</dd>
> </dlentry><dlentry>
> <dt>Disk I/O</dt>
> -<dd> Disk input/output transmission rate in KB per seconds.</dd>
> +<dd>Disk input/output transmission rate in KB per seconds.</dd>
> </dlentry><dlentry>
> <dt>Livetile</dt>
> -<dd rev="rev1">State of guest operating system console, or an icon
> -that represents the <tm tmtype="tm" trademark="Linux">Linux</tm> distribution
> -if the guest is not active.</dd>
> +<dd>State of guest operating system console, or an icon that represents
> +the <tm tmtype="tm" trademark="Linux">Linux</tm> distribution if the
> +guest is not active.</dd>
> </dlentry></dl></p>
> <p>The following actions icons are displayed for each guest:<dl>
> <dlentry>
> -<dt rev="rev1">Reset</dt>
> -<dd rev="rev1">Click to reset the guest. </dd>
> +<dt>Reset</dt>
> +<dd>Click to reset the guest. </dd>
> </dlentry><dlentry>
> -<dt><tm tmclass="IGNORE" tmtype="reg" trademark="Power">Power</tm> (Start
> -or Stop)</dt>
> +<dt>Power (Start or Stop)</dt>
> <dd>Click to power on or power off the guest. If the icon is red,
> the power is off; if the icon is green, the power is on.</dd>
> </dlentry></dl> </p>
> <p>The following actions can be selected for each guest:<ul>
> -<li>Select <uicontrol>VNC</uicontrol> to connect to the remote console
> -for the guest operating system.</li>
> +<li>Select <uicontrol>Connect</uicontrol> to connect to the remote
> +console for the guest operating system.</li>
> +<li>Select <uicontrol>Manage media</uicontrol> to change the path
> +to the installation media.</li>
> +<li>Select <uicontrol>Reset</uicontrol> to reset the guest.</li>
> <li>Select <uicontrol>Edit</uicontrol> to edit the properties of an
> existing guest. Guests can be edited only while stopped.</li>
> <li>Select <uicontrol>Delete</uicontrol> to delete the guest.</li>
> @@ -66,16 +68,12 @@ create a template.</li>
> </cshelp>
> <cshelp id="kimhvirtmedit" xml:lang="en-us">
> <title>Edit guest</title>
> -<shortdesc rev="rev1">Edit the properties of an existing virtual machine.
> -Guests can be edited only while stopped.</shortdesc>
> -<csprolog><csmetadata>
> -<cswindowtitle>Title of window or panel associated with this help;
> -for review output only.</cswindowtitle>
> -<cswidgetlabel>Name of field or control associated with this help;
> -for review output only</cswidgetlabel>
> -</csmetadata></csprolog>
> +<shortdesc>Edit the properties of an existing virtual machine. Guests
> +can be edited only while stopped.</shortdesc>
> +<csprolog><csmetadata></csmetadata></csprolog>
> <csbody>
> -<p>For each guest, the following information is displayed:<dl><dlentry>
> +<p>For each guest, the following information is displayed on the <wintitle>General</wintitle> tab:<dl>
> +<dlentry>
> <dt>Name</dt>
> <dd>Name of the virtual machine.</dd>
> </dlentry><dlentry>
> @@ -86,14 +84,51 @@ for review output only</cswidgetlabel>
> <dd>Amount of memory in MB.</dd>
> </dlentry><dlentry>
> <dt>Icon</dt>
> -<dd rev="rev2"> Graphic image representing the Linux distribution
> -to be displayed in place of current status (Livetile) when the guest
> -is not active.</dd>
> +<dd>Graphic image representing the Linux distribution to be displayed
> +in place of current status (Livetile) when the guest is not active.</dd>
> </dlentry></dl></p>
> +<p>The following information is displayed on the <wintitle>Storage</wintitle> tab.</p>
> +<dl><dlentry>
> +<dt>Storage</dt>
> +<dd>Displays the location of the ISO file used for installation.</dd>
> +</dlentry></dl><?Pub Caret -2?>
> <p> Fields that are not disabled can be edited. After you edit a field,
> click <uicontrol>Save</uicontrol>. </p>
> </csbody>
> -</cshelp><?Pub Caret -1?>
> +</cshelp>
> +<cshelp id="kimstoragedevice" xml:lang="en-us">
> +<title>Add, replace, or detach a storage device</title>
> +<shortdesc rev="rev1">You can add, replace, or detach a storage device
> +to your virtual machine. The only supported device is CDROM. To edit
> +your storage devices, follow these steps:</shortdesc>
> +<csbody>
> +<ol>
> +<li>On the <wintitle>Edit Guest</wintitle> window, select <wintitle>Storage</wintitle>.</li>
> +<li>To replace a storage device, click the first icon with the <uicontrol>orange
> +slash (/)</uicontrol>. Enter the ISO file path and click <uicontrol>Replace</uicontrol>.</li>
> +<li>To detach a storage device, click the second icon with the <uicontrol>red
> +dash (-)</uicontrol>. Confirm the deletion and click <uicontrol>OK</uicontrol>.</li>
> +<li>To add a storage device, click the third icon with the green <uicontrol>plus
> +sign (+)</uicontrol>. Enter a device name and ISO file path and click <uicontrol>Attach</uicontrol>.</li>
> +</ol>
> +</csbody>
> +</cshelp>
> +<cshelp id="kimreplacemedia" xml:lang="en-us">
> +<title>Replace a CDROM of VM</title>
> +<shortdesc rev="rev1">You can replace the contents of the CDROM for
> +a virtual machine after the installation is complete.</shortdesc>
> +<csbody>
> +<ol>
> +<li>Ensure that the virtual machine is started.</li>
> +<li>From the Actions menu, select <uicontrol>Manage Media</uicontrol>.</li>
> +<li>To change what is currently loaded in the CDROM, click the <uicontrol>orange
> +slash (/)</uicontrol> icon next to the hdc field.</li>
> +<li>On the <wintitle>Replace a CDROM of VM</wintitle> page, enter
> +the ISO file path. The other two fields are read-only.</li>
> +<li>Click <uicontrol>Replace</uicontrol>.</li>
> +</ol>
> +</csbody>
> +</cshelp>
> <?tm 1391540919 3?>
> </cshelp>
> -<?Pub *0000003805?>
> +<?Pub *0000005541?>
> diff --git a/ui/pages/help/host.dita b/ui/pages/help/host.dita
> index d961edc..1b60b27 100644
> --- a/ui/pages/help/host.dita
> +++ b/ui/pages/help/host.dita
> @@ -9,16 +9,16 @@ For support please see:
> https://w3.opensource.ibm.com/projects/dita-cshelp/-->
> <cshelp id="kimhhost" xml:lang="en-us">
> <title>Host</title>
> -<shortdesc rev="rev1">The <wintitle>Host</wintitle> page shows information
> -about the host system, and allows you to shut down, restart, and connect
> +<shortdesc>The <wintitle>Host</wintitle> page shows information about
> +the host system, and allows you to shut down, restart, and connect
> to the host.</shortdesc>
> <csbody>
> <p>You can perform the following actions on the host:<ul>
> <li>Select <uicontrol>Shut down</uicontrol> to shut down the host
> system.</li>
> <li>Select <uicontrol>Restart</uicontrol> to restart the host system.</li>
> -<li rev="rev1">Select <uicontrol>Connect</uicontrol> to open a VNC
> -connection to the host system, if it is not already connected.</li>
> +<li>Select <uicontrol>Connect</uicontrol> to open a VNC connection
> +to the host system, if it is not already connected.</li>
> </ul></p>
> <p>Click the following sections to display information about the host:<dl>
> <dlentry>
> @@ -28,24 +28,30 @@ version, and code name, as well as the processor type and amount of
> memory in GB.</dd>
> </dlentry><dlentry>
> <dt>System statistics</dt>
> -<dd rev="rev1">This section displays graphs to show statistics for
> -CPU, memory, disk I/O, and network I/O for the host. Select <uicontrol>Collecting
> +<dd>This section displays graphs to show statistics for CPU, memory,
> +disk I/O, and network I/O for the host. Select <uicontrol>Collecting
> data after leaving this page</uicontrol> to continue collecting data
> when the host tab is out of view.</dd>
> </dlentry><dlentry>
> +<dt>Software Updates</dt>
> +<dd>This section displays information for all of the packages that
> +have updates available, including package name, version, architecture,
> +and repository. You can update all of the packages listed by selecting <uicontrol>Update
> +All</uicontrol>. You cannot select individual packages for updates.</dd>
> +</dlentry><dlentry>
> <dt>Debug reports</dt>
> -<dd rev="rev1">This section displays debug reports, including name
> -and file path. You can select from options to generate a new report,
> -or rename, remove, or download an existing report.<p>The debug report
> -is generated using the <cmdname>sosreport</cmdname> command. It is
> -available for Red Hat Enterprise <tm tmtype="tm" trademark="Linux">Linux</tm>,
> -Fedora, and Ubuntu distributions. The command generates a .tar file
> -that contains configuration and diagnostic information, such as the
> -running kernel version, loaded modules, and system and service configuration
> -files. The command also runs external programs to collect further
> -information and stores this output in the resulting archive.</p> </dd>
> -</dlentry></dl></p>
> -</csbody><?Pub Caret -2?>
> +<dd>This section displays debug reports, including name and file path.
> +You can select from options to generate a new report, or rename, remove,
> +or download an existing report.<p>The debug report is generated using
> +the <cmdname>sosreport</cmdname> command. It is available for Red
> +Hat Enterprise <tm tmtype="tm" trademark="Linux">Linux</tm>, Fedora,
> +and Ubuntu distributions. The command generates a .tar file that contains
> +configuration and diagnostic information, such as the running kernel
> +version, loaded modules, and system and service configuration files.
> +The command also runs external programs to collect further information
> +and stores this output in the resulting archive.</p> </dd>
> +</dlentry></dl><?Pub Caret 693?></p>
> +</csbody>
> <?tm 1392659967 1?>
> </cshelp>
> -<?Pub *0000002392?>
> +<?Pub *0000002695?>
> diff --git a/ui/pages/help/templates.dita b/ui/pages/help/templates.dita
> index d0122ec..8306681 100644
> --- a/ui/pages/help/templates.dita
> +++ b/ui/pages/help/templates.dita
> @@ -56,7 +56,7 @@ is configured to use.</dd>
> <dd>Amount of memory in MB to be allocated to the virtual machine.</dd>
> </dlentry><dlentry>
> <dt>Disk</dt>
> -<dd rev="rev1">Disk size in GB.</dd>
> +<dd>Disk size in GB.</dd>
> </dlentry><dlentry>
> <dt>CDROM</dt>
> <dd>File path to the location of the ISO file used to install the
> @@ -66,10 +66,10 @@ KVM guest.</dd>
> <dd>Specific storage pool or the default storage pool.</dd>
> </dlentry><dlentry>
> <dt>Network</dt>
> -<dd rev="rev1">Default network interfaces available to the KVM guest.
> -You can select multiple networks.</dd>
> -</dlentry></dl><?Pub Caret 681?> Fields that are not disabled can
> -be edited. After you edit a field, click <uicontrol>Save</uicontrol>. </p>
> +<dd>Default network interfaces available to the KVM guest. You can
> +select multiple networks.</dd>
> +</dlentry></dl> Fields that are not disabled can be edited. After
> +you edit a field, click <uicontrol>Save</uicontrol>. </p>
> </csbody>
> </cshelp>
> <cshelp id="kimhaddtempl">
> @@ -108,15 +108,15 @@ Templates from Selected ISO</uicontrol>.</li>
> <li>Select <uicontrol>All</uicontrol> to create a template from each
> listed ISO image, then click <uicontrol>Create Templates from Selected
> ISO</uicontrol>.</li>
> -<li rev="rev1">If the ISO image that you want to use does not appear
> -in the scan results, you can select from the following options:<ul>
> +<li>If the ISO image that you want to use does not appear in the scan
> +results, you can select from the following options:<ul>
> <li>Select <uicontrol>I want to use a specific ISO file</uicontrol> to
> specify a path to the ISO image.</li>
> <li>Click <uicontrol>Search more ISOs</uicontrol> to search for more
> ISO images.</li>
> -</ul></li>
> +</ul></li><?Pub Caret 0?>
> </ul></p>
> </csbody>
> </cshelp>
> </cshelp>
> -<?Pub *0000004468?>
> +<?Pub *0000004433?>
--
Adam King <rak at linux.vnet.ibm.com>
IBM CSI
More information about the Kimchi-devel
mailing list