diff --git a/doc/requirements.txt b/doc/requirements.txt index 92009cfb4..32a998304 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,4 @@ +sphinxcontrib.datatemplates openstackdocstheme>=2.2.1 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD Pillow>=2.4.0 # PIL License diff --git a/doc/source/conf.py b/doc/source/conf.py index 001b13f3f..19e36bab1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,6 +32,7 @@ sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts')) extensions = [ 'sphinx.ext.extlinks', 'sphinx.ext.todo', + 'sphinxcontrib.datatemplates', 'openstackdocstheme', 'acs', 'members', diff --git a/doc/source/templates/sigs_repos_table.tmpl b/doc/source/templates/sigs_repos_table.tmpl new file mode 100644 index 000000000..0e7a64eeb --- /dev/null +++ b/doc/source/templates/sigs_repos_table.tmpl @@ -0,0 +1,16 @@ +.. -*- mode: rst -*- + +.. This template renders a table showing repositories under the maintainership of OpenStack SIGs + +.. list-table:: + :header-rows: 1 + :align: left + + - * SIG + * Repositories +{%- for sig in data %} + - * {{ sig }} + * {%- for item in data[sig] %} + | `{{ item['repo'] }} `_ + {%- endfor %} +{%- endfor %} \ No newline at end of file diff --git a/doc/source/templates/technical_committee_repos_table.tmpl b/doc/source/templates/technical_committee_repos_table.tmpl new file mode 100644 index 000000000..8aba722b7 --- /dev/null +++ b/doc/source/templates/technical_committee_repos_table.tmpl @@ -0,0 +1,12 @@ +.. -*- mode: rst -*- + +.. This template renders a table showing repositories under the maintainership of the OpenStack Technical Committee + +.. list-table:: + :align: left + :header-rows: 1 + + - * Repository + {%- for line in data['Technical Committee'] %} + - * `{{ line['repo'] }} `_ + {%- endfor %} \ No newline at end of file diff --git a/reference/comparison-of-official-group-structures.rst b/reference/comparison-of-official-group-structures.rst index c78f87c2c..0ac218720 100644 --- a/reference/comparison-of-official-group-structures.rst +++ b/reference/comparison-of-official-group-structures.rst @@ -65,8 +65,9 @@ co-leads. Since they are not directly in charge of producing OpenStack, only limited accountability is required, and SIGs do not have any required named liaisons. -SIGs can own git repositories and produce software, but that software will be -considered add-on software to the main "OpenStack" software releases. Therefore +SIGs :doc:`can own git repositories ` and produce +software, but that software will be considered add-on software to the main +"OpenStack" software releases. Therefore SIGs deliverables are not part of the coordinated release, and will not leverage the openstack/releases repository. If a SIG does release any tooling or software they are responsible for any release management/tagging needed. @@ -121,7 +122,8 @@ contributors to the open source project. It may delegate rights (and duties) to `TC working groups`_ (like the Election officials which have a delegation for running elections). -The TC owns git repositories (generally around governance documents) but does +The TC owns :doc:`git repositories (generally around governance documents) +` but does not produce OpenStack deliverables by itself. Board of Directors, Board committees and working groups diff --git a/reference/index.rst b/reference/index.rst index 38320109b..92b734af1 100644 --- a/reference/index.rst +++ b/reference/index.rst @@ -16,13 +16,13 @@ Reference documents which need to be revised over time. technical-vision upstream-investment-opportunities/index role-of-the-tc + technical-committee-repos new-projects-requirements new-language-requirements dropping-projects licensing base-services user-committee-charter - working-groups service-project-naming project-testing-interface irc @@ -31,6 +31,9 @@ Reference documents which need to be revised over time. Requirements for previously-used incubation/integration process house-rules comparison-of-official-group-structures + working-groups + Special Interest Groups + sig-repos tc-guide OpenStack-name-in-external-services election-exceptions diff --git a/reference/role-of-the-tc.rst b/reference/role-of-the-tc.rst index e38905161..e290b5ca3 100644 --- a/reference/role-of-the-tc.rst +++ b/reference/role-of-the-tc.rst @@ -28,7 +28,8 @@ the TC to describe the community structure, systems, operating principles, and values by creating and maintaining corresponding documentation. This is done in the :doc:`Technical Committee charter `, the `TC governance website`_ documents and other TC-maintained publications -such as the `Project Team guide`_. +such as the `Project Team guide`_. See the list of +:doc:`repositories maintained by the TC `. The TC is just one of the governance bodies more widely involved in OpenStack governance. An important part of its role is therefore to diff --git a/reference/sig-repos.rst b/reference/sig-repos.rst new file mode 100644 index 000000000..f58365bc4 --- /dev/null +++ b/reference/sig-repos.rst @@ -0,0 +1,9 @@ +.. _sig-repos: + +=============================== +Repositories maintained by SIGs +=============================== + +.. datatemplate:yaml:: + :source: sigs-repos.yaml + :template: ../../templates/sigs_repos_table.tmpl diff --git a/reference/technical-committee-repos.rst b/reference/technical-committee-repos.rst new file mode 100644 index 000000000..33767e7f6 --- /dev/null +++ b/reference/technical-committee-repos.rst @@ -0,0 +1,9 @@ +.. _tc-repos: + +============================================================ +Repositories maintained by the OpenStack Technical Committee +============================================================ + +.. datatemplate:yaml:: + :source: technical-committee-repos.yaml + :template: ../../templates/technical_committee_repos_table.tmpl