From 179da8704cbd182d823a781360449f1ba6029de3 Mon Sep 17 00:00:00 2001 From: Shilla Saebi Date: Sat, 25 Apr 2015 01:00:39 -0400 Subject: [PATCH] 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 --- doc/source/man/heat-db-setup.rst | 2 +- doc/source/man/heat-keystone-setup-domain.rst | 8 ++++---- doc/source/man/heat-keystone-setup.rst | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/man/heat-db-setup.rst b/doc/source/man/heat-db-setup.rst index 44aaae86c3..275a8ea731 100644 --- a/doc/source/man/heat-db-setup.rst +++ b/doc/source/man/heat-db-setup.rst @@ -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 diff --git a/doc/source/man/heat-keystone-setup-domain.rst b/doc/source/man/heat-keystone-setup-domain.rst index e686f7e7d5..285dace570 100644 --- a/doc/source/man/heat-keystone-setup-domain.rst +++ b/doc/source/man/heat-keystone-setup-domain.rst @@ -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. diff --git a/doc/source/man/heat-keystone-setup.rst b/doc/source/man/heat-keystone-setup.rst index cc5a3e054f..c77a1f9e13 100644 --- a/doc/source/man/heat-keystone-setup.rst +++ b/doc/source/man/heat-keystone-setup.rst @@ -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.