openstack
/
heat
Code Issues Proposed changes

changed heat dev docs to comply with conventions 

With the incorporation of many projects within OpenStack, it's very important to
use standards in the documentation This is important for formalization as well
as consistency
the proper usage is: heat or Orchestration or Orchestration module
heat should not be capitalized
https://wiki.openstack.org/wiki/Documentation/Conventions

Change-Id: Icbc213ecf2f564981e8a1595b5fc557d1b218f9c
This commit is contained in:
Shilla Saebi 2015-04-25 01:00:39 -04:00
parent 23e10121b0
commit 179da8704c
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/man/heat-db-setup.rst
View File

@ -15,7 +15,7 @@ DESCRIPTION
===========
heat-db-setup is a tool which configures the local MySQL database for
heat. Typically distro-specific tools would provide this functionality
so please read the distro-specific documentation for configuring Heat.
so please read the distro-specific documentation for configuring heat.
COMMANDS

8
doc/source/man/heat-keystone-setup-domain.rst
View File

@ -14,21 +14,21 @@ SYNOPSIS
DESCRIPTION
===========
The `heat-keystone-setup-domain` tool configures Keystone by creating
The `heat-keystone-setup-domain` tool configures keystone by creating
a 'stack user domain' and the user credential used to manage this domain.
A 'stack user domain' can be treated as a namespace for projects,
groups and users created by Heat. The domain will have an admin user
groups and users created by heat. The domain will have an admin user
that manages other users, groups and projects in the domain.
This script requires admin keystone credentials to be available in the
shell environment by setting `OS_USERNAME` and `OS_PASSWORD`.
After running this script, a user needs to take actions to check or
modify Heat configuration file (e.g. /etc/heat/heat.conf). The tool
modify the heat configuration file (e.g. /etc/heat/heat.conf). The tool
is NOT performing these updates on behalf of the user.
Distributions may provide other tools to setup 'stack user domain' for
use with Heat, so check the distro documentation first. Other tools
use with heat, so check the distro documentation first. Other tools
are available to set up the 'stack user domain', for example
`python-openstackclient`, which is preferred to this tool where it is
available.

2
doc/source/man/heat-keystone-setup.rst
View File

@ -13,7 +13,7 @@ SYNOPSIS
DESCRIPTION
===========
The heat-keystone-setup tool configures keystone for use with Heat. This script requires admin keystone credentials to be available in the shell environment and write access to /etc/keystone.
The heat-keystone-setup tool configures keystone for use with heat. This script requires admin keystone credentials to be available in the shell environment and write access to /etc/keystone.
Distributions may provide other tools to setup keystone for use with Heat, so check the distro documentation first.