openstack/ui-cookiecutter
Code Issues Proposed changes

Update description of this cookiecutter

Browse Source 
Also this change removes gerrit_id from cookiecutter.json.
This commit is contained in:
Shu Muto 2016-11-17 14:51:32 +09:00
parent 8a3c614f22
commit 33aabc1fc8
4 changed files with 30 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitreview
View File

@ -1,4 +1,4 @@
[gerrit]
host=review.openstack.org
port=xxx
project=openstack-dev/ui-cookiecutter.git
port=29418
project=openstack/ui-cookiecutter.git

17
README.rst
View File

@ -2,7 +2,11 @@
ui-cookiecutter
===============
Cookiecutter template for an OpenStack Dashboard UI plugin project. See https://github.com/audreyr/cookiecutter.
Cookiecutter template for an OpenStack Dashboard UI plugin project. This
generate UI plugin project using Horizon Angular framework and the generated
project includes sample panel with CRUD operations.
See also https://github.com/audreyr/cookiecutter.
* Free software: Apache license
* pbr_: Set up to use Python Build Reasonableness
@ -22,6 +26,15 @@ Generate a Python package project::
cookiecutter https://github.com/shu-mutou/ui-cookiecutter.git
Run with OpenStack Horizon::
cd <repo_name>
pip install
cp <repo_name>/<module_folder>/enabled/_90_project_<panel_group>_panelgroup.py <horizon-dir>/openstack_dashboard/local/enabled
cp <repo_name>/<module_folder>/enabled/_91_project_<panel_group>_<panel>s.py <horizon-dir>/openstack_dashboard/local/enabled
then reboot the Horizon.
OpenStack projects require a working git repo for pbr to work, on newer
versions of cookiecutter (>= 0.7.0 released 2013-11-09) this inital commit will
be done automatically. Otherwise you will need to init a repo and commit to it
@ -32,7 +45,7 @@ before doing anything else::
git add .
git commit -a
Then:
Then::
* Add the project to the OpenStack Infrastructure

25
cookiecutter.json
View File

@ -1,19 +1,18 @@
{
"module_name": "replace with the name of the python module. ex) magnum-ui",
"module_name": "replace with the name of the python module. ex) cafe-ui",
"repo_group": "openstack",
"repo_name": "replace with the name for the git repo. ex) magnum-ui",
"launchpad_project": "replace with the name of the project on launchpad. ex) magnum-ui",
"project_short_description": "OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. ex) Magnum User Interface",
"call_by_name": "replace with the name for calling in text such as README or Help. ex) Magnum UI",
"repo_name": "replace with the name for the git repo. ex) cafe-ui",
"launchpad_project": "replace with the name of the project on launchpad. ex) cafe-ui",
"project_short_description": "OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. ex) Cafe User Interface",
"call_by_name": "replace with the name for calling in text such as README or Help. ex) Cafe UI",
"dashboard": "replace with the name of the dashboard. ex) project",
"panel_group": "replace with the name of the panel_group. ex) container-infra",
"panel_group_name": "replace with the name of the panel_group. ex) Container Infra",
"panel_group": "replace with the name of the panel_group. ex) cafe",
"panel_group_name": "replace with the name of the panel_group. ex) Cafe",
"panel": "replace with the name of the panel in singular. ex) bay",
"panel_func": "replace with the function name for the panel in singular. ex) Bay",
"module_folder": "replace with the name of the module folder. ex) magnum_ui",
"gerrit_id": "replace with the project ID of the gerrit",
"help_name": "replace with the name of the help. ex) Magnum-UI",
"api_module": "replace with the name of the API module. ex) magnum",
"api_name": "replace with the name for calling in text. ex) Magnum"
"panel_func": "replace with the function name for the panel in singular. ex) Drink",
"module_folder": "replace with the name of the module folder. ex) cafe_ui",
"help_name": "replace with the name of the help. ex) Cafe-UI",
"api_module": "replace with the name of the API module. ex) cafe",
"api_name": "replace with the name for calling in text. ex) Cafe"
}

2
{{cookiecutter.repo_name}}/.gitreview
View File

@ -1,4 +1,4 @@
[gerrit]
host=review.openstack.org
port={{ cookiecutter.gerrit_id }}
port=29418
project={{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}.git