From 0b20c8bf2914308920a70433575c5a0114ed6c35 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Thu, 23 Feb 2017 14:26:35 -0500 Subject: [PATCH] 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 --- README.rst | 14 ++++---------- cookiecutter.json | 7 +++---- .../source/common_configure.rst | 0 .../source/common_prerequisites.rst | 0 .../source/conf.py | 0 .../source/get_started.rst | 0 .../source/index.rst | 0 .../source/install-obs.rst | 0 .../source/install-rdo.rst | 0 .../source/install-ubuntu.rst | 0 .../source/install.rst | 0 .../source/next-steps.rst | 0 .../source/verify.rst | 0 13 files changed, 7 insertions(+), 14 deletions(-) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/common_configure.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/common_prerequisites.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/conf.py (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/get_started.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/index.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/install-obs.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/install-rdo.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/install-ubuntu.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/install.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/next-steps.rst (100%) rename {{{cookiecutter.repo_name}}/install-guide => {{cookiecutter.directory_name}}}/source/verify.rst (100%) diff --git a/README.rst b/README.rst index 7ac972e..fdfa38e 100644 --- a/README.rst +++ b/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 `_. 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 `_ on how to contribute. diff --git a/cookiecutter.json b/cookiecutter.json index 96ca6cc..6bcf988 100644 --- a/cookiecutter.json +++ b/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" } diff --git a/{{cookiecutter.repo_name}}/install-guide/source/common_configure.rst b/{{cookiecutter.directory_name}}/source/common_configure.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/common_configure.rst rename to {{cookiecutter.directory_name}}/source/common_configure.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/common_prerequisites.rst b/{{cookiecutter.directory_name}}/source/common_prerequisites.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/common_prerequisites.rst rename to {{cookiecutter.directory_name}}/source/common_prerequisites.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/conf.py b/{{cookiecutter.directory_name}}/source/conf.py similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/conf.py rename to {{cookiecutter.directory_name}}/source/conf.py diff --git a/{{cookiecutter.repo_name}}/install-guide/source/get_started.rst b/{{cookiecutter.directory_name}}/source/get_started.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/get_started.rst rename to {{cookiecutter.directory_name}}/source/get_started.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/index.rst b/{{cookiecutter.directory_name}}/source/index.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/index.rst rename to {{cookiecutter.directory_name}}/source/index.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/install-obs.rst b/{{cookiecutter.directory_name}}/source/install-obs.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/install-obs.rst rename to {{cookiecutter.directory_name}}/source/install-obs.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/install-rdo.rst b/{{cookiecutter.directory_name}}/source/install-rdo.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/install-rdo.rst rename to {{cookiecutter.directory_name}}/source/install-rdo.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/install-ubuntu.rst b/{{cookiecutter.directory_name}}/source/install-ubuntu.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/install-ubuntu.rst rename to {{cookiecutter.directory_name}}/source/install-ubuntu.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/install.rst b/{{cookiecutter.directory_name}}/source/install.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/install.rst rename to {{cookiecutter.directory_name}}/source/install.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/next-steps.rst b/{{cookiecutter.directory_name}}/source/next-steps.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/next-steps.rst rename to {{cookiecutter.directory_name}}/source/next-steps.rst diff --git a/{{cookiecutter.repo_name}}/install-guide/source/verify.rst b/{{cookiecutter.directory_name}}/source/verify.rst similarity index 100% rename from {{cookiecutter.repo_name}}/install-guide/source/verify.rst rename to {{cookiecutter.directory_name}}/source/verify.rst