Initial commit

This sets up the ideas framework.
This repository can be imported in the openstack namespace.

.gitignore

@@ -0,0 +1,7 @@
+.tox
+doc/build
+*.egg-info
+pbr*.egg
+*.pyc
+AUTHORS
+ChangeLog

README.rst

@@ -0,0 +1,9 @@
+This repository contains the base documents for the ideas.openstack.org
+website. This website is the ground of any new idea for OpenStack, crazy or not.
+
+While ideas can be spread on the Mailing Lists, this repository is a way to
+iterate on the ideas while keeping their history in an easier location than the
+mailing lists. Proposal should still be exposed and/or discussed on the mailing
+lists (or other media) for transparency.
+
+Please read ``doc/source/index.rst`` for further details.

doc/source/conf.py

@@ -0,0 +1,299 @@
+# -*- 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 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.join(os.path.abspath('.'), '_exts'))
+
+# -- 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 = [
+    'sphinx.ext.extlinks',
+    'openstackdocstheme',
+]
+
+todo_include_todos = True
+
+# Define shorthand roles for making links to common destinations.
+extlinks = {
+    'repo': ('http://opendev.org/%s', ''),
+}
+
+# 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'OpenStack Ideas'
+copyright = u'2020, OpenStack Foundation'
+
+# 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']
+
+# 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 = []
+
+
+# -- 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 = 'openstackdocs'
+
+# 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 = {
+    'display_global_toc_section': False,
+    'root_title': 'Ideas for OpenStack'
+}
+
+# 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
+# "<project> v<release> documentation".
+html_title = 'Ideas for OpenStack'
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+html_short_title = 'Ideas'
+
+# 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
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# 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 = os.popen(git_cmd).read()
+
+# 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 <link> 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 = 'Tempestdoc'
+
+
+# -- 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', 'openstackideas.tex', u'Ideas for OpenStack',
+   u'OpenStack Foundation', '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 manual page output
+# --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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', 'Ideas', u'OpenStack Ideas',
+   u'OpenStack Foundation', 'Ideas', 'Ideas for OpenStack.',
+   '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'Ideas for OpenStack'
+epub_author = u'OpenStack Foundation'
+epub_publisher = u'OpenStack Foundation'
+epub_copyright = u'2020, OpenStack Foundation'
+
+# 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

doc/source/ideas/EXAMPLE

@@ -0,0 +1,8 @@
+MY IDEA NAME
+============
+
+<What is your idea>
+
+<What's the itch you want to scratch/what do you think we can improve or fix>
+
+<Other info>

doc/source/index.rst

@@ -0,0 +1,94 @@
+===================
+Ideas for OpenStack
+===================
+
+About this website
+==================
+
+This website is a breeding ground for ideas in OpenStack.
+Everyone with an idea can propose it here, even if said idea has been
+discussed/proposed in the past.
+
+Keep in mind, the ideas in this repository can be very fresh or very old.
+The age of the idea does not matter for your contribution.
+Someone wanting to iterate over any idea (even an old one) can do so.
+It is recommended to check the history using git first, though, as
+the history (linked with ML topics) might reveal why an old idea was not
+implemented.
+
+Are the Mailing Lists not enough?
+---------------------------------
+
+Mailing lists are great, use them! In fact, we encourage you to share your idea
+on the mailing list first. However, there are places where Mailing lists fall
+short. For example, the history repeats itself, and people ask the same
+questions all over again "Why don't we change the cycle duration?",
+"Can we change the PTL role?". One possible reason for this is the lack of
+an easy to way to propose, search, browse history, and iterate on ideas.
+The ideas repository is an attempt to fix things.
+
+Can/Should I propose an idea here?
+----------------------------------
+
+Everyone can propose an idea. You don't need to have special credentials.
+The technical committee is responsible for merging your ideas into this
+repository, but it stops there. Only one vote will be required, and the only
+negative votes you can get are the ones that don't reflect what was said on
+the mailing lists. So there is no reason to hold off a patch.
+
+If you have an idea and don't want it to be lost in the memories,
+propose it here.
+
+Proposing an idea doesn't mean being in charge of implementing it. You are
+just sharing your idea for increasing the collective wisdom.
+
+What is the process for any contributions here?
+-----------------------------------------------
+
+The purpose of this system is to be VERY lightweight.
+Even though the repository is curated by the technical committee, the process
+to propose an idea should be done in minutes.
+
+1. Copy the ``ideas/EXAMPLE`` into ``ideas/<my_awesome_idea_name>.rst``
+2. Edit the content of ``ideas/<my_awesome_idea_name>.rst``. The only thing we
+   ask (to help figuring out what the idea is about), is to always have at least
+   2 paragraphs: 1 about the idea itself, 1 about why you want to do it.
+   You can add any extra text into your idea, but we need those two.
+3. When this is created, ``git checkout -b my_awesome_idea_name &&
+   git add . && git commit && git review -f``.
+   In your commit title, please ALWAYS mention a conversation on the mailing
+   list. In other words, make sure your idea or idea update was discussed,
+   and that your commit is representative of a part of the conversation.
+   This is necessary because it helps retracing updates with the mailing list,
+   when checking the git log.
+
+There is no limit in terms of the amounts of commit for any single idea.
+
+What if my idea is completely crazy?
+------------------------------------
+
+There is NO reason to keep that for you, as long as it is relevant for
+OpenStack as a whole. Crazy ideas are more than welcome!
+On top of that, you might find other crazy people to help you on the way.
+
+I think idea <x> is plain wrong/outdated, how can I fix this?
+-------------------------------------------------------------
+
+Just speak about it on the Mailing list, and edit the idea in this repo.
+
+I like this idea, how can I help?
+---------------------------------
+
+That's simple: Check ``git blame`` on the current idea. You will find people
+interested in the idea. You can then contact them about progress and give a
+hand.
+
+Proposed ideas
+==============
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+   :glob:
+
+   ideas/*

ideas

@@ -0,0 +1 @@
+doc/source/ideas/

requirements.txt

@@ -0,0 +1,3 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.

setup.cfg

@@ -0,0 +1,16 @@
+[metadata]
+name = openstack-ideas
+summary = OpenStack Ideas
+description-file =
+    README.rst
+author = Jean-Philippe Evrard
+author-email = openstack-discuss@lists.openstack.org
+home-page = http://www.openstack.org/
+
+[build_sphinx]
+all_files = 1
+build-dir = doc/build
+source-dir = doc/source
+
+[pbr]
+warnerrors = True

setup.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
+#
+# 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.
+
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
+import setuptools
+
+setuptools.setup(
+    setup_requires=['pbr'],
+    pbr=True)

test-requirements.txt

@@ -0,0 +1,6 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+# needed for doc build
+openstackdocstheme>=1.31.2  # Apache-2.0
+sphinx>=1.5.0  # BSD

tox.ini

@@ -0,0 +1,16 @@
+[tox]
+envlist = docs
+minversion = 1.6
+skipsdist = True
+
+[testenv]
+usedevelop = True
+install_command = pip install -U {opts} {packages}
+setenv = VIRTUAL_ENV={envdir}
+deps = -r{toxinidir}/test-requirements.txt
+
+[testenv:venv]
+commands = {posargs}
+
+[testenv:docs]
+commands = python setup.py build_sphinx