From d5b3824759d68748a3e3fb37856963b530732c67 Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Tue, 20 May 2014 11:08:34 -0700 Subject: [PATCH] Initial commit with a template. Change-Id: Ieb97f6bdfef360733ec0d98d0151b4a15fcd7cf6 --- .coveragerc | 7 +++ .gitignore | 51 ++++++++++++++++ .mailmap | 3 + .testr.conf | 7 +++ CONTRIBUTING.rst | 15 +++++ LICENSE | 3 + MANIFEST.in | 6 ++ README.rst | 47 +++++++++++++++ doc/source/conf.py | 83 ++++++++++++++++++++++++++ doc/source/contributing.rst | 1 + doc/source/index.rst | 27 +++++++++ doc/source/readme.rst | 1 + doc/source/specs | 1 + doc/source/template.rst | 1 + requirements.txt | 3 + setup.cfg | 23 ++++++++ setup.py | 22 +++++++ specs/test.rst | 84 ++++++++++++++++++++++++++ template.rst | 114 ++++++++++++++++++++++++++++++++++++ test-requirements.txt | 0 tox.ini | 25 ++++++++ 21 files changed, 524 insertions(+) create mode 100644 .coveragerc create mode 100644 .gitignore create mode 100644 .mailmap create mode 100644 .testr.conf create mode 100644 CONTRIBUTING.rst create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.rst create mode 100755 doc/source/conf.py create mode 120000 doc/source/contributing.rst create mode 100644 doc/source/index.rst create mode 120000 doc/source/readme.rst create mode 120000 doc/source/specs create mode 120000 doc/source/template.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100755 setup.py create mode 100644 specs/test.rst create mode 100644 template.rst create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..e858f51 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,7 @@ +[run] +branch = True +source = infra-specs +omit = infra-specs/tests/*,infra-specs/openstack/* + +[report] +ignore-errors = True diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dfe851d --- /dev/null +++ b/.gitignore @@ -0,0 +1,51 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox +nosetests.xml +.testrepository + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Complexity +output/*.html +output/*/index.html + +# Sphinx +doc/build + +# pbr generates these +AUTHORS +ChangeLog + +# Editors +*~ +.*.swp diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000..516ae6f --- /dev/null +++ b/.mailmap @@ -0,0 +1,3 @@ +# Format is: +# +# diff --git a/.testr.conf b/.testr.conf new file mode 100644 index 0000000..6d83b3c --- /dev/null +++ b/.testr.conf @@ -0,0 +1,7 @@ +[DEFAULT] +test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ + OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ + OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ + ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION +test_id_option=--load-list $IDFILE +test_list_option=--list diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..02e6627 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,15 @@ +=========================== +Contributing to infra-specs +=========================== + +If you would like to contribute to the development of OpenStack, +you must follow the steps in the "If you're a developer, start here" +section of this page: + + http://wiki.openstack.org/HowToContribute + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://wiki.openstack.org/GerritWorkflow diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..75a29c4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,3 @@ +This work is licensed under a Creative Commons Attribution 3.0 Unported License. + +http://creativecommons.org/licenses/by/3.0/legalcode diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c978a52 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include AUTHORS +include ChangeLog +exclude .gitignore +exclude .gitreview + +global-exclude *.pyc diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..4be3225 --- /dev/null +++ b/README.rst @@ -0,0 +1,47 @@ +====================== +Infra Specs Repository +====================== + +This is a git repository for doing design review on enhancements to +the OpenStack Project Infrastructure. This provides an ability to +ensure that everyone has signed off on the approach to solving a +problem early on. + +Repository Structure +==================== +The expected structure of the respository is as follows:: + + specs/ + implemented/ + + +Expected Work Flow +================== + +1. Create a story in StoryBoard with a task affecting the + ``infra-specs`` project. +2. Propose review to infra-specs repository (ensure Story: is + in the commit message). +3. Leave a comment with the Gerrit address of the specification. +4. Bring forward the proposed item to the infra meeting for summary. +5. Review happens on proposal by infra-core members and others. +6. Iterate until review is Approved or Rejected. + +Once a specification is Approved... + +1. Update story, copy summary text of specification to there. +2. Leave a comment to the git address of the specification. + + +Revisiting Specifications +========================= +We don't always get everything right the first time. If we realize we +need to revisit a specification because something changed, either we +now know more, or a new idea came in which we should embrace, we'll +manage this by proposing an update to the specification in question. + +Learn As We Go +============== +This is a new way of attempting things, so we're going to be low in +process to begin with to figure out where we go from here. Expect some +early flexibility in evolving this effort over time. diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..2d0eb75 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,83 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) +# -- General configuration ---------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', + #'sphinx.ext.intersphinx', + 'oslosphinx' +] + +# Optionally allow the use of sphinxcontrib.spelling to verify the +# spelling of the documents. +try: + import sphinxcontrib.spelling + extensions.append('sphinxcontrib.spelling') +except ImportError: + pass + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'infra-specs' +copyright = u'2013, OpenStack Foundation' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output -------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +# html_theme_path = ["."] +# html_theme = '_theme' +# html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', + '%s.tex' % project, + u'%s Documentation' % project, + u'OpenStack Foundation', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 120000 index 0000000..e9a8ba6 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1 @@ +../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..283b020 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,27 @@ +Infrastructure Design Specifications +==================================== + +.. toctree:: + :glob: + :maxdepth: 2 + + specs/** + + +Specifications Repository Information +===================================== + +.. toctree:: + :maxdepth: 2 + + README + contributing + Sample Template