3b5d1a5de3
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Do not set version for releasenotes, they are always unversioned. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ia2fa8ed0001da2696c87253ad2251260a4a90882
ui-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
- hacking: Enforces the OpenStack Hacking Guidelines
- eslint: Enfoces the JavaScript Guidelines
- testrepository: Runs tests using testrepository
- OpenStack-Infra: Ready for OpenStack Continuous Integration testing
- Tox testing: Setup to easily test for Python 2.7, 3.4
- karma testing: Setup to easily test for JavaScript
- Sphinx docs: Documentation ready for generation and publication
- reno : Sphinx extension for Release Notes
Usage
Generate a Python package project:
cookiecutter https://github.com/openstack/ui-cookiecutter.gitThis command prompts interactive input. Please check these parameters:
* "repo_group": The name for the git repo group. e.g. "openstack"
* "repo_name": The name for the git repo. e.g. "cafe-ui", This is used as python package name too.
* "launchpad_project": The name of the project on launchpad. e.g. "cafe-ui",
* "project_short_description": The short descriptions for your UI. e.g. "Cafe User Interface",
* "help_name": The name for the help. e.g. "Cafe-UI",
* "call_by_name": The name of this UI to write texts such as README or Help. e.g. "Cafe UI",
* "module_name": The name of the python module. e.g. "cafe_ui"
* "dashboard": The slug of the "dashboard" you want to add this plugin into. e.g. "project",
* "panel_group": The slug for the "panel_group". e.g. "cafe",
* "panel_group_name": The caption for the "panel_group". e.g. "Cafe",
* "panel": The slug of the "panel", in singular. e.g. "drink",
* "panel_func": The function name for the "panel", in singular. e.g. "Drink",
* "api_module": The name of the API service module. e.g. "cafe",
* "api_name": The caption for the "api_module". e.g. "Cafe"If you want to generate without interactive input, you can use example values for these parameters as follow:
cookiecutter https://github.com/openstack/ui-cookiecutter.git --no-inputRun with OpenStack Horizon:
cd <repo_name>
pip install
cp <repo_name>/<module_name>/enabled/_90_project_<panel_group>_panelgroup.py <horizon-dir>/openstack_dashboard/local/enabled
cp <repo_name>/<module_name>/enabled/_91_project_<panel_group>_<panel>s.py <horizon-dir>/openstack_dashboard/local/enabledthen 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 before doing anything else:
cd $repo_name
git init
git add .
git commit -aThen:
* Add the project to the OpenStack Infrastructure