openstack/openstack-manuals
Code Issues Proposed changes

Fix user guide typos and text

Browse Source 
Updated ubuntu user to format with <literal> in
  /openstack-manuals/doc/user-guide/section_dashboard_launch_instances.xml,
  and changed "username" to "user name."

  Updated "etc" to "and so on," changed "Heat" to "Orchestration,"
  and changed intro paragraph about Orchestration to match what's on the
  OpenStack getting started site in:
  /openstack-manuals/doc/user-guide/section_dashboard_stacks.xml

Change-Id: Ie33d9a31c9d8b1ada31bf1c226ccb92eb0c08f1f
This commit is contained in:
Eric Scholz 2014-03-06 09:08:33 -07:00 committed by Diane Fleming
parent 3252523129
commit 98dacc0492
2 changed files with 40 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/user-guide/section_dashboard_launch_instances.xml
View File

@ -10,14 +10,16 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="dashboard_launch_instances">
<title>Launch and manage instances</title>
<para>Instances are virtual machines that run inside the cloud.</para>
<para>You can <link linkend="dashboard_launch_instances_from_image">launch
an instance from an OpenStack image</link>. The OpenStack
<para>Instances are virtual machines that run inside the
cloud.</para>
<para>You can <link
linkend="dashboard_launch_instances_from_image">launch an
instance from an OpenStack image</link>. The OpenStack
Image Service provides a pool of images that are accessible to
members of different projects.</para>
<para>You can also
<link linkend="dashboard_launch_instances_from_volume">launch
an instance from an image that you have copied to a
<para>You can also <link
linkend="dashboard_launch_instances_from_volume">launch an
instance from an image that you have copied to a
persistent volume</link>. The instance boots from the
volume, which is provided by <systemitem class="service"
>nova-volume</systemitem> through iSCSI. When you launch
@ -52,8 +54,8 @@
<para>To SSH into your instance, you use the downloaded
keypair file.</para>
<note>
<para>The username is ubuntu for the Ubuntu cloud images
on TryStack.</para>
<para>The user name is <literal>ubuntu</literal> for the
Ubuntu cloud images on TryStack.</para>
</note>
<procedure>
<step>
@ -72,15 +74,15 @@
</section>
<section xml:id="track_usage">
<title>Track usage for instances</title>
<para>You can track usage for instances for each tenant, also known as a project. You
can track costs per month by showing metrics like number
of VCPUs, disks, RAM, and uptime for all your
instances.</para>
<para>You can track usage for instances for each tenant, also
known as a project. You can track costs per month by
showing metrics like number of VCPUs, disks, RAM, and
uptime for all your instances.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a
project, and click the
<guilabel>Overview</guilabel> category.</para>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Overview</guilabel>
category.</para>
</step>
<step>
<para>To query the instance usage for a month, select
@ -97,9 +99,8 @@
<title>Create instance snapshots</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a
project, and click the
<guilabel>Instances</guilabel>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Instances</guilabel>
category.</para>
</step>
<step>
@ -129,9 +130,8 @@
<title>Manage an instance</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a
project, and click the
<guilabel>Instances</guilabel>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Instances</guilabel>
category.</para>
</step>
<step>
@ -141,7 +141,10 @@
<para>In the <guilabel>More</guilabel> drop-down list
in the <guilabel>Actions</guilabel> column, select
the state.</para>
<para>You can resize or rebuild an instance. You can also choose to view the instance console log. Depending on the current state of the instance, you can choose to pause, resume, suspend, soft or
<para>You can resize or rebuild an instance. You can
also choose to view the instance console log.
Depending on the current state of the instance,
you can choose to pause, resume, suspend, soft or
hard reboot, or terminate an instance.</para>
</step>
</procedure>

28
doc/user-guide/section_dashboard_stacks.xml
View File

@ -10,24 +10,24 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="dashboard_stacks">
<title>Launch and manage stacks</title>
<para>Heat is a service used to orchestrate multiple composite
cloud applications using the AWS CloudFormation template
format, through both an OpenStack-native ReST API and a
CloudFormation-compatible Query API.</para>
<para>The purpose of Heat is to provide a template based
orchestration for describing a cloud application by executing
appropriate OpenStack API calls to generate running cloud
applications, integrate other core components of OpenStack
into a one-file template system. The templates allow creation
of most OpenStack resource types such as instances, floating
ips, volumes, security groups, users, etc.</para>
<para>Orchestration is a service used to orchestrate
multiple composite cloud applications using the AWS
CloudFormation template format, through both an
OpenStack-native REST API and a CloudFormation-compatible
Query API.</para>
<para>The flexible template language enables application
developers to describe and automate the deployment of
infrastructure, services, and applications. The templates
allow creation of most OpenStack resource types such as
instances, floating ips, volumes, security groups, users, and
so on.</para>
<section xml:id="dashboard_create_stacks">
<title>Launch a stack</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a
project, and click <guibutton>Stacks</guibutton>
in the <guilabel>Orchestration</guilabel>
<para>Log in to the dashboard, choose a project, and
click <guibutton>Stacks</guibutton> in the
<guilabel>Orchestration</guilabel>
category.</para>
</step>
<step>