Fix directory structure and improve README file
The generated source should be placed in a directory call 'install-guide' inside existing repositories. Because of that the creation of the repository directory itself is not possible. Cookiecutter requires a directory call {{cookiecutter..}} as starting point. Because of that the only solution without modifing cookiecutter itself is to add a dummy directory_name variable. This change also improves the README file. The use of this cookiecutter template is documeted in the OpenStack Contributor Guide. Change-Id: I43685feb521a8b0cf53ed4e92dfede8aeddb00b7
This commit is contained in:
parent
f7062a525b
commit
0b20c8bf29
14
README.rst
14
README.rst
|
@ -5,8 +5,6 @@ Team and repository tags
|
||||||
.. image:: http://governance.openstack.org/badges/installguide-cookiecutter.svg
|
.. image:: http://governance.openstack.org/badges/installguide-cookiecutter.svg
|
||||||
:target: http://governance.openstack.org/reference/tags/index.html
|
:target: http://governance.openstack.org/reference/tags/index.html
|
||||||
|
|
||||||
.. Change things from this point on
|
|
||||||
|
|
||||||
==========================
|
==========================
|
||||||
Install Guide Cookiecutter
|
Install Guide Cookiecutter
|
||||||
==========================
|
==========================
|
||||||
|
@ -18,15 +16,11 @@ cookiecutter.
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Generate a Install Guide skeleton::
|
The usage of this tool is documented in the
|
||||||
|
`OpenStack Contributor Guide <https://docs.openstack.org/contributor-guide/project-install-guide.html>`_.
|
||||||
cookiecutter https://git.openstack.org/openstack/installguide-cookiecutter.git
|
|
||||||
|
|
||||||
Answer the questions and add the created REPO/install-guide directory
|
|
||||||
to your repository REPO.
|
|
||||||
|
|
||||||
Contribution
|
Contribution
|
||||||
------------
|
------------
|
||||||
|
|
||||||
This repo is part of the OpenStack docs team, see
|
This repo is part of the OpenStack docs team, see our
|
||||||
http://docs.openstack.org/contributor-guide/ on how to contribute.
|
`Contributor Guide <http://docs.openstack.org/contributor-guide/>`_ on how to contribute.
|
||||||
|
|
|
@ -1,6 +1,5 @@
|
||||||
{
|
{
|
||||||
"repo_name": "replace with name of repo",
|
"service": "replace with the name of the service like Networking or Compute",
|
||||||
"service": "replace with the name of the service like Networking or Compute",
|
"codename": "replace with the codename like neutron or nova",
|
||||||
"codename": "replace with the codename like neutron or nova"
|
"directory_name": "install-guide"
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue