openstack-heat/tools
ricolin 6f5e393a9b Add StoryBoard migration docs and releasenote
Heat curent bug/bluepint reports are migrated from Launchpad to
StoryBoard [1]. If you like to create a new story(a bug or a bluepint),
please file it under [2]. For more detail, please reference [3]. This
change applied to all heat projects.
This patch Add documents and guideline link to StoryBoard.
Also add releasenote to showing migration message.

[1] https://storyboard.openstack.org/#!/project_group/82
[2] https://storyboard.openstack.org/#!/project/989
[3] https://etherpad.openstack.org/p/Heat-StoryBoard-Migration-Info

Change-Id: I7c7dab88d269f92c66b3f68352a6913aa244fdfc
2018-07-26 13:05:04 +08:00
..
dashboards Add StoryBoard migration docs and releasenote 2018-07-26 13:05:04 +08:00
cfn-json2yaml Make the first line of every file consistent. 2014-03-04 09:03:04 -06:00
custom_guidelines.py Use correct raw string format 2017-11-16 18:23:58 -05:00
heat-db-drop heat tools : heat-db-drop prompt for missing password 2012-07-05 10:46:53 +01:00
README.rst Docs: modernise links 2018-04-11 16:46:07 -04:00
test-requires-deb Add lists of Linux dependencies 2015-01-23 16:02:53 +00:00
test-requires-rpm Add lists of Linux dependencies 2015-01-23 16:02:53 +00:00
test-setup.sh Prepare for using standard python tests 2017-02-04 09:49:18 +01:00

Files in this directory are general developer tools or examples of how
to do certain activities.

If you're running on Fedora, see the instructions at https://docs.openstack.org/heat/latest/getting_started/on_fedora.html

Tools
=====

heat-db-drop
  This script drops the heat database from mysql in the case of developer
  data corruption or erasing heat.

cfn-json2yaml
  (bulk) convert AWS CloudFormation templates written in JSON
  to HeatTemplateFormatVersion YAML templates

Package lists
=============

Lists of Linux packages to install in order to successfully run heat's
unit test suit on a clean new Linux distribution.

test-requires-deb
  list of DEB packages as of Ubuntu 14.04 Trusty

test-requires-rpm
  list of RPM packages as of Fedora 20

Review dashboards
=================

Generate gerrit review URL for heat. This can pop up some patches
that might requires reviews. You can generate it with following
command under `gerrit-dash-creator` repo
( https://git.openstack.org/cgit/openstack/gerrit-dash-creator )

    $ ./gerrit-dash-creator heat.dash

The sample of heat.dash can be found under ./dashboards/

Get the output URL and add it to your gerrit menu
(at ``https://review.openstack.org/#/settings/preferences``).