openstack/specs-cookiecutter
Code Issues Proposed changes
Cookiecutter templates for new specs repos
38 Commits 1 Branch 0 Tags 175 KiB
Python 100%
6fb715b47c
Go to file
Ghanshyam Mann 6fb715b47c [community goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38556
Change-Id: I4bfe9db179fdf2285e847544cdb98c597ec388a6
2021-05-17 19:28:10 -05:00
{{cookiecutter.repo_name}} Update to openstackdocstheme 2020-06-09 07:04:43 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:16 +00:00
CONTRIBUTING.rst [community goal] Update contributor documentation 2021-05-17 19:28:10 -05:00
cookiecutter.json Fix cookiecutter json again 2014-03-26 15:19:14 -04:00
README.rst Replace ci.o.o links with docs.o.o/infra 2015-05-14 21:38:16 +00:00

README.rst

specs-cookiecutter

Cookiecutter template for an OpenStack specs repo projects. See https://github.com/audreyr/cookiecutter.

  • Free software: Apache license
  • pbr: Set up to use Python Build Reasonableness
  • OpenStack-Infra: Ready for OpenStack Continuous Integration testing
  • Tox testing: Setup to easily building sphunx docs
  • Sphinx docs: Documentation ready for generation and publication

Usage

Generate a Python package project:

cookiecutter https://git.openstack.org/openstack-dev/specs-cookiecutter.git

OpenStack projects require a working git repo for pbr to work, so you need to init a repo and commit to it before doing anything else:

cd $repo_name
git init
git add .
git commit -a

Then:

  • Add the project to the OpenStack Infrastructure