openstack
/
openstack-doc-tools
Code Issues Proposed changes

[cli-ref] add heat deprecation note 

As of https://review.openstack.org/#/c/291631/ the heat CLI is deprecated.

Change-Id: Id759651a135a9ace0c6b331e4ad5ecb22e5707c8
This commit is contained in:
Christian Berendt 2016-04-25 13:58:16 -05:00
parent 984c9f8184
commit cec83cebf4
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
os_doc_tools/commands.py
View File

@ -92,6 +92,14 @@ def generate_heading(os_command, api_name, title,
os_file.write(".. #################################################\n\n")
format_heading(title, 1, os_file)
if os_command == "heat":
os_file.write(".. warning::\n\n")
os_file.write(" The " + os_command + " CLI is deprecated\n")
os_file.write(" in favor of python-openstackclient.\n")
os_file.write(" For more information, see :doc:`openstack`.\n")
os_file.write(" For a Python library, continue using\n")
os_file.write(" python-" + os_command + "client.\n\n")
if os_command == "openstack":
os_file.write("The openstack client is a common OpenStack")
os_file.write("command-line interface (CLI).\n\n")