update readme as the other modules of the forge

Change-Id: I3f73b47c2556f0893a33d498b66498e145759794
This commit is contained in:
Sebastien Badia 2014-02-21 13:36:19 +01:00
parent 603fb20795
commit f0a7780954
2 changed files with 54 additions and 21 deletions

21
README
View File

@ -1,21 +0,0 @@
puppet-heat
This is the Heat module.
License
-------
Apache License 2.0
Copyright 2012 eNovance <licensing@enovance.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

54
README.md Normal file
View File

@ -0,0 +1,54 @@
puppet-heat
=============
#### Table of Contents
1. [Overview - What is the heat module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with heat](#setup)
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Contributors - Those with commits](#contributors)
8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
Overview
--------
The heat module is a part of [Stackforge](https://github.com/stackforge), an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software. The module itself is used to flexibly configure and manage the baremetal service for Openstack.
Module Description
------------------
Setup
-----
**What the heat module affects:**
* heat, the orchestration service for Openstack.
Implementation
--------------
### puppet-heat
puppet-heat is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.
Limitations
-----------
Development
-----------
Developer documentation for the entire puppet-openstack project.
* https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
Contributors
------------
* https://github.com/stackforge/puppet-heat/graphs/contributors
Release Notes
-------------