openstack/puppet-openstack-cookiecutter
Code Issues Proposed changes

Fix various editorial problems

Browse Source 
Fix a few editorial problems found:
* Use git.openstack.org instead of github.com since git.openstack.org is
  the reference for OpenStack.
* Fix reference to repos, some used stackforge instead of openstack
  namespace.
* Fix spelling of OpenStack.
* Remove mention of puppet-openstack module, it does not exist anymore.

Change-Id: Id1c24f53dce396931236e178565bc11daa9949ea
This commit is contained in:
Andreas Jaeger 2016-01-09 13:04:38 +01:00
parent cfceb401e3
commit eeaaf18b10
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,6 @@
# puppet-openstack-cookiecutter
Cookiecutter template for a compliant Openstack puppet-modules
Cookiecutter template for a compliant OpenStack puppet-modules
## Installation
@ -12,13 +12,13 @@ There are two ways to create the boilerplate for the puppet module.
### Locally
1. Clone locally the [puppet-openstack-cookiecutter](https://github.com/openstack/puppet-openstack-cookiecutter.git) repository.
1. Clone locally the [puppet-openstack-cookiecutter](https://git.openstack.org/openstack/cgit/puppet-openstack-cookiecutter) repository.
2. Run `cookiecutter /path/to/cloned/repo`
### Remotely (ie. using a git repo)
1. Run `cookiecutter https://github.com/openstack/puppet-openstack-cookiecutter.git`
1. Run `cookiecutter https://git.openstack.org/openstack-infra/puppet-openstack-cookiecutter.git`
## What's next
Once the boilerplate created, in order to be compliant with the other modules, the files managed by [msync](https://github.com/puppet-community/modulesync), (or [configs](https://github.com/openstack/puppet-modulesync-configs)) needs to be in the project folder. Once synced module is ready, announce its existence to the ML, make the proper patch to openstack-infra and finally wait for the reviews to do the rest.
Once the boilerplate created, in order to be compliant with the other modules, the files managed by [msync](https://github.com/puppet-community/modulesync), (or [configs](https://git.openstack.org/openstack/cgit/puppet-modulesync-configs)) needs to be in the project folder. Once synced module is ready, announce its existence to the ML, make the proper patch to openstack-infra and finally wait for the reviews to do the rest.

6
puppet-{{cookiecutter.project_name}}/README.md
View File

@ -14,7 +14,7 @@
Overview
--------
The {{cookiecutter.project_name}} module is a part of [OpenStack](https://github.com/openstack), 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 its self is used to flexibly configure and manage the FIXME service for Openstack.
The {{cookiecutter.project_name}} module is a part of [OpenStack](https://www.openstack.org), 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 its self is used to flexibly configure and manage the FIXME service for OpenStack.
Module Description
------------------
@ -26,7 +26,7 @@ Setup
**What the {{cookiecutter.project_name}} module affects**
* [{{cookiecutter.project_name|capitalize}}](https://wiki.openstack.org/wiki/{{cookiecutter.project_name|capitalize}}), the FIXME service for Openstack.
* [{{cookiecutter.project_name|capitalize}}](https://wiki.openstack.org/wiki/{{cookiecutter.project_name|capitalize}}), the FIXME service for OpenStack.
### Installing {{cookiecutter.project_name}}
@ -35,7 +35,7 @@ Setup
### Beginning with {{cookiecutter.project_name}}
To utilize the {{cookiecutter.project_name}} module's functionality you will need to declare multiple resources. The following is a modified excerpt from the [openstack module](https://github.com/stackfoge/puppet-openstack). This is not an exhaustive list of all the components needed, we recommend you consult and understand the [openstack module](https://github.com/stackforge/puppet-openstack) and the [core openstack](http://docs.openstack.org) documentation.
To utilize the {{cookiecutter.project_name}} module's functionality you will need to declare multiple resources.
Implementation
--------------