From ad544f387eaa015c3dfde6c006edbcc88bcc6c98 Mon Sep 17 00:00:00 2001 From: Witold Bedyk Date: Thu, 14 Sep 2017 18:19:43 +0200 Subject: [PATCH] Define repository structure Change-Id: Ie2d6f4391f8d711aa057c6cc3ff6fd475ee73754 --- .gitignore | 10 + LICENSE | 3 + README.rst | 35 +++ doc/source/conf.py | 282 +++++++++++++++++++ doc/source/index.rst | 156 +++++++++++ doc/source/priorities | 1 + doc/source/redirect.py | 50 ++++ doc/source/specs/backlog/approved | 1 + doc/source/specs/backlog/index.rst | 21 ++ doc/source/specs/backlog/template.rst | 1 + doc/source/specs/queens/approved | 1 + doc/source/specs/queens/implemented | 1 + doc/source/specs/queens/index.rst | 26 ++ doc/source/specs/queens/template.rst | 1 + priorities/queens-priorities.rst | 12 + requirements.txt | 9 + setup.cfg | 23 ++ setup.py | 29 ++ specs/.gitignore | 0 specs/queens-template.rst | 378 ++++++++++++++++++++++++++ test-requirements.txt | 5 + tox.ini | 35 +++ 22 files changed, 1080 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.rst create mode 100755 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 120000 doc/source/priorities create mode 100644 doc/source/redirect.py create mode 120000 doc/source/specs/backlog/approved create mode 100644 doc/source/specs/backlog/index.rst create mode 120000 doc/source/specs/backlog/template.rst create mode 120000 doc/source/specs/queens/approved create mode 120000 doc/source/specs/queens/implemented create mode 100644 doc/source/specs/queens/index.rst create mode 120000 doc/source/specs/queens/template.rst create mode 100644 priorities/queens-priorities.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 specs/.gitignore create mode 100644 specs/queens-template.rst create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6efcb00 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +AUTHORS +ChangeLog +build +.tox +.venv +*.egg* +*.swp +*.swo +*.pyc +.testrepository 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/README.rst b/README.rst new file mode 100644 index 0000000..ee3f8d2 --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +======================== +Team and repository tags +======================== + +.. image:: https://governance.openstack.org/tc/badges/monasca-specs.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html + + .. Change things from this point on + +====== +README +====== + +Monasca Specifications +====================== + + +This git repository is used to hold priorities and approved design +specifications for additions to the Monasca project. Reviews of the specs are +done in gerrit, using a similar workflow to how we review and merge changes to +the code itself. + +The layout of this repository is:: + + priorities// + specs// + +Where there are two sub-directories in ``specs``: + +specs//approved + specifications approved, but not yet implemented + +specs//implemented + implemented specifications + diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..28d5b63 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,282 @@ +# -*- coding: utf-8 -*- +# +# Tempest documentation build configuration file, created by +# sphinx-quickstart on Tue May 21 17:43:32 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import datetime +import subprocess +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['redirect', + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', + 'sphinx.ext.mathjax', + 'oslosphinx', + 'yasfb', + ] + +# Feed configuration for yasfb +feed_base_url = 'http://specs.openstack.org/openstack/monasca-specs' +feed_author = 'Monasca Team' + +todo_include_todos = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Monasca Specs' +copyright = u'%s, Monasca Team' % datetime.date.today().year + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [ + '_build', + 'image_src/plantuml/README.rst', +] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# 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 = False + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +modindex_common_prefix = ['monasca-specs.'] + +# -- Options for man page output ---------------------------------------------- +man_pages = [] + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", + "-n1"] +html_last_updated_fmt = subprocess.Popen( + git_cmd, stdout=subprocess.PIPE).communicate()[0] + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +html_domain_indices = False + +# If false, no index is generated. +html_use_index = False + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Monasca-Specsdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Monasca-specs.tex', u'Monasca Specs', + u'Monasca Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Monasca-specs', u'Monasca Design Specs', + u'Monasca Team', 'monasca-specs', 'Design specifications for the Monasca project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Monasca Specs' +epub_author = u'Monasca Team' +epub_publisher = u'Monasca Team' +epub_copyright = u'2015, Monasca Team' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True +suppress_warnings = ['image.nonlocal_uri'] diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..6196774 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,156 @@ +.. monasca-specs documentation master file + +===================== +Monasca Project Plans +===================== + +Priorities +========== + +At the beginning of each release cycle we agree what the whole community wants +to focus on for the upcoming release. This is the output of those discussions: + +.. toctree:: + :glob: + :maxdepth: 1 + + priorities/* + +Specifications +============== + +Here you can find the specs, and spec template, for each release: + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/queens/index + +There are also some approved backlog specifications that are looking for +owners: + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/backlog/index + +Process +======= + +The lifecycle of a specification +-------------------------------- + +Developers proposing a specification should propose a new file in the +``approved`` directory. monasca-specs-core will review the change in the usual +manner for the OpenStack project and eventually it will get merged if a +consensus is reached. As the developer of an approved specification, it is your +responsibility to assign tasks to your story. Developers are then free to +propose code reviews to implement their specification. These reviews should be +sure to reference the Storyboard story and task in their commit message for +tracking purposes. + +Once all code for the feature is merged into Monasca, the Storyboard story is +marked complete. + +Periodically, someone from monasca-specs-core will move implemented +specifications from the ``approved`` directory to the ``implemented`` +directory. Whilst individual developers are welcome to propose this move for +their implemented specifications, we have generally just done this in a batch +at the end of the release cycle. It is important to create redirects when this +is done so that existing links to the approved specification are not broken. +Redirects aren't symbolic links, they are defined in a file which sphinx +consumes. + +This directory structure allows you to see what we thought about doing, +decided to do and actually got done. Users interested in functionality in a +given release should only refer to the ``implemented`` directory. + +Example specifications +---------------------- + +You can find an example spec in ``specs/-template.rst``. + +Backlog specifications +---------------------- + +Additionally, we allow the proposal of specifications that do not have a +developer assigned to them. These are proposed for review in the same manner as +above, but are added to:: + + specs/backlog/approved + +Specifications in this directory indicate the original author has either +become unavailable or has indicated that they are not going to implement the +specification. The specifications found here are available as projects for +people looking to get involved with Monasca. If you are interested in +claiming a spec, start by posting a review for the specification that moves it +from this directory to the next active release. Please set yourself as the new +`primary assignee` and maintain the original author in the `other contributors` +list. + +Working with gerrit and specification unit tests +------------------------------------------------ + +For more information about working with gerrit, see +http://docs.openstack.org/infra/manual/developers.html#development-workflow + +To validate that the specification is syntactically correct (i.e. get more +confidence in the Jenkins result), please execute the following command:: + + $ tox + +After running ``tox``, the documentation will be available for viewing in HTML +format in the ``doc/build/`` directory. + +Specification review policies +============================= + +There are a number of review policies which monasca-specs-core will apply when +reviewing proposed specifications. They are: + +Trivial specifications +---------------------- + +Proposed changes which are trivial (very small amounts of code) and don't +change any of our public APIs are sometimes not required to provide a +specification. In these cases a Storyboard story is considered sufficient. +These proposals are approved during the `Open Discussion` portion of the +weekly Monasca IRC meeting. If you think your proposed feature is trivial and +meets these requirements, we recommend you bring it up for discussion there +before writing a full specification. + +Previously approved specifications +---------------------------------- + +`Specifications are only approved for a single release`. If your specification +was previously approved but not implemented (or not completely implemented), +then you must seek re-approval for the specification. You can re-propose your +specification by doing the following: + +* Copy (not move) your specification to the right directory for the current + release. +* Update the document to comply with the new template. +* If there are no functional changes to the specification (only template + changes) then add the `Previously-approved: ` tag to your commit + message. +* Send for review. +* monasca-specs-core will merge specifications which meet these requirements + with a single +2. + +Specifications which depend on merging code in other OpenStack projects +----------------------------------------------------------------------- + +For specifications `that depend on code in other OpenStack projects merging` +we will not approve the Monasca specification until the code in that other +project has merged. To indicate your specification is in this state, please +use the Depends-On git commit message tag. The correct format is +`Depends-On: `. monasca-specs-core can approve the +specification at any time, but it won't merge until the code we need to land +in the other project has merged as well. + +Indices and tables +================== + +* :ref:`search` diff --git a/doc/source/priorities b/doc/source/priorities new file mode 120000 index 0000000..9ab1b77 --- /dev/null +++ b/doc/source/priorities @@ -0,0 +1 @@ +../../priorities \ No newline at end of file diff --git a/doc/source/redirect.py b/doc/source/redirect.py new file mode 100644 index 0000000..099159f --- /dev/null +++ b/doc/source/redirect.py @@ -0,0 +1,50 @@ +# A simple sphinx plugin which creates HTML redirections from old names +# to new names. It does this by looking for files named "redirect" in +# the documentation source and using the contents to create simple HTML +# redirection pages for changed filenames. + +import os.path + +from sphinx.application import ENV_PICKLE_FILENAME +from sphinx.util.console import bold + + +def setup(app): + from sphinx.application import Sphinx + if not isinstance(app, Sphinx): + return + app.connect('build-finished', emit_redirects) + + +def process_redirect_file(app, path, ent): + parent_path = path.replace(app.builder.srcdir, app.builder.outdir) + with open(os.path.join(path, ent)) as redirects: + for line in redirects.readlines(): + from_path, to_path = line.rstrip().split(' ') + from_path = from_path.replace('.rst', '.html') + to_path = to_path.replace('.rst', '.html') + + redirected_filename = os.path.join(parent_path, from_path) + redirected_directory = os.path.dirname(redirected_filename) + if not os.path.exists(redirected_directory): + os.makedirs(redirected_directory) + with open(redirected_filename, 'w') as f: + f.write('' + % to_path) + + +def emit_redirects(app, exc): + app.builder.info(bold('scanning %s for redirects...') % app.builder.srcdir) + + def process_directory(path): + for ent in os.listdir(path): + p = os.path.join(path, ent) + if os.path.isdir(p): + process_directory(p) + elif ent == 'redirects': + app.builder.info(' found redirects at %s' % p) + process_redirect_file(app, path, ent) + + process_directory(app.builder.srcdir) + app.builder.info('...done') diff --git a/doc/source/specs/backlog/approved b/doc/source/specs/backlog/approved new file mode 120000 index 0000000..f9bcc67 --- /dev/null +++ b/doc/source/specs/backlog/approved @@ -0,0 +1 @@ +../../../../specs/backlog/approved \ No newline at end of file diff --git a/doc/source/specs/backlog/index.rst b/doc/source/specs/backlog/index.rst new file mode 100644 index 0000000..53e1e80 --- /dev/null +++ b/doc/source/specs/backlog/index.rst @@ -0,0 +1,21 @@ +============================== +Monasca Backlog Specifications +============================== + +These specifications are ideas and features that are desirable but do not have +anyone working on them. + +Template: + +.. toctree:: + :maxdepth: 1 + + Specification Template