Browse Source

Initial content

Initial content for the governance website page.

For more information, see:
http://specs.openstack.org/openstack-infra/infra-specs/specs/neutral-governance-website.html

Change-Id: I44f90b258869e53b03cdb66e5d7f637de0197aec
changes/47/395647/1
Thierry Carrez 2 years ago
parent
commit
d3eb09d1c0
9 changed files with 420 additions and 0 deletions
  1. 7
    0
      .gitignore
  2. 2
    0
      README.rst
  3. 296
    0
      doc/source/conf.py
  4. 51
    0
      doc/source/index.rst
  5. 3
    0
      requirements.txt
  6. 17
    0
      setup.cfg
  7. 22
    0
      setup.py
  8. 6
    0
      test-requirements.txt
  9. 16
    0
      tox.ini

+ 7
- 0
.gitignore View File

@@ -0,0 +1,7 @@
1
+.tox
2
+doc/build
3
+*.egg-info
4
+pbr*.egg
5
+*.pyc
6
+AUTHORS
7
+ChangeLog

+ 2
- 0
README.rst View File

@@ -0,0 +1,2 @@
1
+This repository contains the base documents for the governance.openstack.org
2
+website, pointing to various subsites.

+ 296
- 0
doc/source/conf.py View File

@@ -0,0 +1,296 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# Tempest documentation build configuration file, created by
4
+# sphinx-quickstart on Tue May 21 17:43:32 2013.
5
+#
6
+# This file is execfile()d with the current directory set to its containing
7
+# dir.
8
+#
9
+# Note that not all possible configuration values are present in this
10
+# autogenerated file.
11
+#
12
+# All configuration values have a default; values that are commented out
13
+# serve to show the default.
14
+
15
+import sys
16
+import os
17
+
18
+# If extensions (or modules to document with autodoc) are in another directory,
19
+# add these directories to sys.path here. If the directory is relative to the
20
+# documentation root, use os.path.abspath to make it absolute, like shown here.
21
+sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts'))
22
+
23
+# -- General configuration
24
+# -----------------------------------------------------
25
+
26
+# If your documentation needs a minimal Sphinx version, state it here.
27
+#needs_sphinx = '1.0'
28
+
29
+# Add any Sphinx extension module names here, as strings. They can be
30
+# extensions
31
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32
+extensions = [
33
+    'sphinx.ext.extlinks',
34
+    'oslosphinx',
35
+]
36
+
37
+todo_include_todos = True
38
+
39
+# Define shorthand roles for making links to common destinations.
40
+extlinks = {
41
+    'repo': ('http://git.openstack.org/cgit/%s', ''),
42
+}
43
+
44
+# Add any paths that contain templates here, relative to this directory.
45
+templates_path = ['_templates']
46
+
47
+# The suffix of source filenames.
48
+source_suffix = '.rst'
49
+
50
+# The encoding of source files.
51
+#source_encoding = 'utf-8-sig'
52
+
53
+# The master toctree document.
54
+master_doc = 'index'
55
+
56
+# General information about the project.
57
+project = u'OpenStack Governance'
58
+copyright = u'2016, OpenStack Foundation'
59
+
60
+# The language for content autogenerated by Sphinx. Refer to documentation
61
+# for a list of supported languages.
62
+#language = None
63
+
64
+# There are two options for replacing |today|: either, you set today to some
65
+# non-false value, then it is used:
66
+#today = ''
67
+# Else, today_fmt is used as the format for a strftime call.
68
+#today_fmt = '%B %d, %Y'
69
+
70
+# List of patterns, relative to source directory, that match files and
71
+# directories to ignore when looking for source files.
72
+exclude_patterns = ['_build']
73
+
74
+# The reST default role (used for this markup: `text`) to use for all
75
+# documents.
76
+#default_role = None
77
+
78
+# If true, '()' will be appended to :func: etc. cross-reference text.
79
+#add_function_parentheses = True
80
+
81
+# If true, the current module name will be prepended to all description
82
+# unit titles (such as .. function::).
83
+add_module_names = False
84
+
85
+# If true, sectionauthor and moduleauthor directives will be shown in the
86
+# output. They are ignored by default.
87
+show_authors = False
88
+
89
+# The name of the Pygments (syntax highlighting) style to use.
90
+pygments_style = 'sphinx'
91
+
92
+# A list of ignored prefixes for module index sorting.
93
+modindex_common_prefix = []
94
+
95
+
96
+# -- Options for HTML output
97
+# ---------------------------------------------------
98
+
99
+# The theme to use for HTML and HTML Help pages.  See the documentation for
100
+# a list of builtin themes.
101
+html_theme = 'nature'
102
+
103
+# Theme options are theme-specific and customize the look and feel of a theme
104
+# further.  For a list of options available for each theme, see the
105
+# documentation.
106
+#html_theme_options = {}
107
+
108
+# Add any paths that contain custom themes here, relative to this directory.
109
+#html_theme_path = []
110
+
111
+# The name for this set of Sphinx documents.  If None, it defaults to
112
+# "<project> v<release> documentation".
113
+#html_title = None
114
+
115
+# A shorter title for the navigation bar.  Default is the same as html_title.
116
+#html_short_title = None
117
+
118
+# The name of an image file (relative to this directory) to place at the top
119
+# of the sidebar.
120
+#html_logo = None
121
+
122
+# The name of an image file (within the static path) to use as favicon of the
123
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
124
+# pixels large.
125
+#html_favicon = None
126
+
127
+# Add any paths that contain custom static files (such as style sheets) here,
128
+# relative to this directory. They are copied after the builtin static files,
129
+# so a file named "default.css" will overwrite the builtin "default.css".
130
+html_static_path = ['_static']
131
+
132
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
133
+# using the given strftime format.
134
+git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
135
+html_last_updated_fmt = os.popen(git_cmd).read()
136
+
137
+# If true, SmartyPants will be used to convert quotes and dashes to
138
+# typographically correct entities.
139
+#html_use_smartypants = True
140
+
141
+# Custom sidebar templates, maps document names to template names.
142
+#html_sidebars = {}
143
+
144
+# Additional templates that should be rendered to pages, maps page names to
145
+# template names.
146
+#html_additional_pages = {}
147
+
148
+# If false, no module index is generated.
149
+html_domain_indices = False
150
+
151
+# If false, no index is generated.
152
+html_use_index = False
153
+
154
+# If true, the index is split into individual pages for each letter.
155
+#html_split_index = False
156
+
157
+# If true, links to the reST sources are added to the pages.
158
+#html_show_sourcelink = True
159
+
160
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
161
+#html_show_sphinx = True
162
+
163
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
164
+#html_show_copyright = True
165
+
166
+# If true, an OpenSearch description file will be output, and all pages will
167
+# contain a <link> tag referring to it.  The value of this option must be the
168
+# base URL from which the finished HTML is served.
169
+#html_use_opensearch = ''
170
+
171
+# This is the file name suffix for HTML files (e.g. ".xhtml").
172
+#html_file_suffix = None
173
+
174
+# Output file base name for HTML help builder.
175
+htmlhelp_basename = 'Tempestdoc'
176
+
177
+
178
+# -- Options for LaTeX output
179
+# --------------------------------------------------
180
+
181
+latex_elements = {
182
+# The paper size ('letterpaper' or 'a4paper').
183
+#'papersize': 'letterpaper',
184
+
185
+# The font size ('10pt', '11pt' or '12pt').
186
+#'pointsize': '10pt',
187
+
188
+# Additional stuff for the LaTeX preamble.
189
+#'preamble': '',
190
+}
191
+
192
+# Grouping the document tree into LaTeX files. List of tuples
193
+# (source start file, target name, title, author, documentclass
194
+# [howto/manual]).
195
+latex_documents = [
196
+  ('index', 'Governance.tex', u'OpenStack Governance',
197
+   u'OpenStack Foundation', 'manual'),
198
+]
199
+
200
+# The name of an image file (relative to this directory) to place at the top of
201
+# the title page.
202
+#latex_logo = None
203
+
204
+# For "manual" documents, if this is true, then toplevel headings are parts,
205
+# not chapters.
206
+#latex_use_parts = False
207
+
208
+# If true, show page references after internal links.
209
+#latex_show_pagerefs = False
210
+
211
+# If true, show URL addresses after external links.
212
+#latex_show_urls = False
213
+
214
+# Documents to append as an appendix to all manuals.
215
+#latex_appendices = []
216
+
217
+# If false, no module index is generated.
218
+#latex_domain_indices = True
219
+
220
+
221
+# -- Options for manual page output
222
+# --------------------------------------------
223
+
224
+# One entry per manual page. List of tuples
225
+# (source start file, name, description, authors, manual section).
226
+man_pages = [
227
+]
228
+
229
+# If true, show URL addresses after external links.
230
+#man_show_urls = False
231
+
232
+
233
+# -- Options for Texinfo output
234
+# ------------------------------------------------
235
+
236
+# Grouping the document tree into Texinfo files. List of tuples
237
+# (source start file, target name, title, author,
238
+#  dir menu entry, description, category)
239
+texinfo_documents = [
240
+  ('index', 'Governance', u'OpenStack Governance',
241
+   u'OpenStack Foundation', 'Governance', 'One line description of project.',
242
+   'Miscellaneous'),
243
+]
244
+
245
+# Documents to append as an appendix to all manuals.
246
+#texinfo_appendices = []
247
+
248
+# If false, no module index is generated.
249
+#texinfo_domain_indices = True
250
+
251
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
252
+#texinfo_show_urls = 'footnote'
253
+
254
+
255
+# -- Options for Epub output
256
+# ---------------------------------------------------
257
+
258
+# Bibliographic Dublin Core info.
259
+epub_title = u'OpenStack Governance'
260
+epub_author = u'OpenStack Foundation'
261
+epub_publisher = u'OpenStack Foundation'
262
+epub_copyright = u'2016, OpenStack Foundation'
263
+
264
+# The language of the text. It defaults to the language option
265
+# or en if the language is not set.
266
+#epub_language = ''
267
+
268
+# The scheme of the identifier. Typical schemes are ISBN or URL.
269
+#epub_scheme = ''
270
+
271
+# The unique identifier of the text. This can be a ISBN number
272
+# or the project homepage.
273
+#epub_identifier = ''
274
+
275
+# A unique identification for the text.
276
+#epub_uid = ''
277
+
278
+# A tuple containing the cover image and cover page html template filenames.
279
+#epub_cover = ()
280
+
281
+# HTML files that should be inserted before the pages created by sphinx.
282
+# The format is a list of tuples containing the path and title.
283
+#epub_pre_files = []
284
+
285
+# HTML files shat should be inserted after the pages created by sphinx.
286
+# The format is a list of tuples containing the path and title.
287
+#epub_post_files = []
288
+
289
+# A list of files that should not be packed into the epub file.
290
+#epub_exclude_files = []
291
+
292
+# The depth of the table of contents in toc.ncx.
293
+#epub_tocdepth = 3
294
+
295
+# Allow duplicate toc entries.
296
+#epub_tocdup = True

+ 51
- 0
doc/source/index.rst View File

@@ -0,0 +1,51 @@
1
+======================
2
+ OpenStack Governance
3
+======================
4
+
5
+The OpenStack project is governed by three separate governance bodies,
6
+formally defined in the `OpenStack Foundation bylaws`_.
7
+
8
+
9
+Board of Directors
10
+------------------
11
+
12
+The `OpenStack Board of Directors <https://wiki.openstack.org/wiki/Governance/Foundation>`_
13
+has oversight over the OpenStack Foundation, and the assets the Foundation
14
+protects (such as the OpenStack trademark). It is composed of appointed
15
+representatives from Platinum sponsors, elected representatives from Gold
16
+sponsors, and elected independent representatives. For more information about
17
+the OpenStack Board of Directors, click
18
+`here <https://wiki.openstack.org/wiki/Governance/Foundation>`_.
19
+
20
+
21
+Technical Committee
22
+-------------------
23
+
24
+The `OpenStack Technical Committee <http://governance.openstack.org/tc/>`_ has
25
+oversight over technical matters and the upstream open source project. Its
26
+membership is directly elected by the contributors to the upstream project. For
27
+more information about the Technical Committee, including its charter, current
28
+membership, reference documents and past resolutions, click
29
+`here <http://governance.openstack.org/tc/>`_.
30
+
31
+
32
+User Committee
33
+--------------
34
+
35
+The `OpenStack User Committee <http://governance.openstack.org/uc/>`_
36
+represents the downstream users of the OpenStack software. Its membership is
37
+currently appointed by the three governing bodies, but should be directly
38
+elected soon. For more information about the User Committee, click
39
+`here <http://governance.openstack.org/uc/>`_.
40
+
41
+
42
+Elections
43
+---------
44
+
45
+OpenStack governance bodies and leaders are regularly renewed using elections.
46
+You can find more information about community-organized PTL and Technical
47
+Committee elections `here <http://governance.openstack.org/election/>`_.
48
+
49
+
50
+.. _`OpenStack Foundation bylaws`: http://www.openstack.org/legal/bylaws-of-the-openstack-foundation/
51
+

+ 3
- 0
requirements.txt View File

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

+ 17
- 0
setup.cfg View File

@@ -0,0 +1,17 @@
1
+[metadata]
2
+name = openstack-governance-website
3
+version = 2016.1
4
+summary = OpenStack Governance
5
+description-file =
6
+    README.rst
7
+author = OpenStack Foundation
8
+author-email = openstack@lists.openstack.org
9
+home-page = http://www.openstack.org/
10
+
11
+[build_sphinx]
12
+all_files = 1
13
+build-dir = doc/build
14
+source-dir = doc/source
15
+
16
+[pbr]
17
+warnerrors = True

+ 22
- 0
setup.py View File

@@ -0,0 +1,22 @@
1
+#!/usr/bin/env python
2
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
3
+#
4
+# Licensed under the Apache License, Version 2.0 (the "License");
5
+# you may not use this file except in compliance with the License.
6
+# You may obtain a copy of the License at
7
+#
8
+#    http://www.apache.org/licenses/LICENSE-2.0
9
+#
10
+# Unless required by applicable law or agreed to in writing, software
11
+# distributed under the License is distributed on an "AS IS" BASIS,
12
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13
+# implied.
14
+# See the License for the specific language governing permissions and
15
+# limitations under the License.
16
+
17
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
18
+import setuptools
19
+
20
+setuptools.setup(
21
+    setup_requires=['pbr'],
22
+    pbr=True)

+ 6
- 0
test-requirements.txt View File

@@ -0,0 +1,6 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+# needed for doc build
5
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
6
+oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0

+ 16
- 0
tox.ini View File

@@ -0,0 +1,16 @@
1
+[tox]
2
+envlist = docs
3
+minversion = 1.6
4
+skipsdist = True
5
+
6
+[testenv]
7
+usedevelop = True
8
+install_command = pip install -U {opts} {packages}
9
+setenv = VIRTUAL_ENV={envdir}
10
+deps = -r{toxinidir}/test-requirements.txt
11
+
12
+[testenv:venv]
13
+commands = {posargs}
14
+
15
+[testenv:docs]
16
+commands = python setup.py build_sphinx

Loading…
Cancel
Save