Browse Source

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
changes/77/437577/1
Christian Berendt 6 years ago
parent
commit
0b20c8bf29
  1. 14
      README.rst
  2. 7
      cookiecutter.json
  3. 0
      {{cookiecutter.directory_name}}/source/common_configure.rst
  4. 0
      {{cookiecutter.directory_name}}/source/common_prerequisites.rst
  5. 0
      {{cookiecutter.directory_name}}/source/conf.py
  6. 0
      {{cookiecutter.directory_name}}/source/get_started.rst
  7. 0
      {{cookiecutter.directory_name}}/source/index.rst
  8. 0
      {{cookiecutter.directory_name}}/source/install-obs.rst
  9. 0
      {{cookiecutter.directory_name}}/source/install-rdo.rst
  10. 0
      {{cookiecutter.directory_name}}/source/install-ubuntu.rst
  11. 0
      {{cookiecutter.directory_name}}/source/install.rst
  12. 0
      {{cookiecutter.directory_name}}/source/next-steps.rst
  13. 0
      {{cookiecutter.directory_name}}/source/verify.rst

14
README.rst

@ -5,8 +5,6 @@ Team and repository tags
.. image:: http://governance.openstack.org/badges/installguide-cookiecutter.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
==========================
Install Guide Cookiecutter
==========================
@ -18,15 +16,11 @@ cookiecutter.
Usage
-----
Generate a Install Guide skeleton::
cookiecutter https://git.openstack.org/openstack/installguide-cookiecutter.git
Answer the questions and add the created REPO/install-guide directory
to your repository REPO.
The usage of this tool is documented in the
`OpenStack Contributor Guide <https://docs.openstack.org/contributor-guide/project-install-guide.html>`_.
Contribution
------------
This repo is part of the OpenStack docs team, see
http://docs.openstack.org/contributor-guide/ on how to contribute.
This repo is part of the OpenStack docs team, see our
`Contributor Guide <http://docs.openstack.org/contributor-guide/>`_ on how to contribute.

7
cookiecutter.json

@ -1,6 +1,5 @@
{
"repo_name": "replace with name of repo",
"service": "replace with the name of the service like Networking or Compute",
"codename": "replace with the codename like neutron or nova"
"service": "replace with the name of the service like Networking or Compute",
"codename": "replace with the codename like neutron or nova",
"directory_name": "install-guide"
}

0
{{cookiecutter.repo_name}}/install-guide/source/common_configure.rst → {{cookiecutter.directory_name}}/source/common_configure.rst

0
{{cookiecutter.repo_name}}/install-guide/source/common_prerequisites.rst → {{cookiecutter.directory_name}}/source/common_prerequisites.rst

0
{{cookiecutter.repo_name}}/install-guide/source/conf.py → {{cookiecutter.directory_name}}/source/conf.py

0
{{cookiecutter.repo_name}}/install-guide/source/get_started.rst → {{cookiecutter.directory_name}}/source/get_started.rst

0
{{cookiecutter.repo_name}}/install-guide/source/index.rst → {{cookiecutter.directory_name}}/source/index.rst

0
{{cookiecutter.repo_name}}/install-guide/source/install-obs.rst → {{cookiecutter.directory_name}}/source/install-obs.rst

0
{{cookiecutter.repo_name}}/install-guide/source/install-rdo.rst → {{cookiecutter.directory_name}}/source/install-rdo.rst

0
{{cookiecutter.repo_name}}/install-guide/source/install-ubuntu.rst → {{cookiecutter.directory_name}}/source/install-ubuntu.rst

0
{{cookiecutter.repo_name}}/install-guide/source/install.rst → {{cookiecutter.directory_name}}/source/install.rst

0
{{cookiecutter.repo_name}}/install-guide/source/next-steps.rst → {{cookiecutter.directory_name}}/source/next-steps.rst

0
{{cookiecutter.repo_name}}/install-guide/source/verify.rst → {{cookiecutter.directory_name}}/source/verify.rst

Loading…
Cancel
Save