Show TC and SIG repos under reference

Doing this is useful since we lack
human-readable web pages to point to
when answering the question:
"What repositories are under
OpenStack TC's governance charter?"

Change-Id: I5672a7f0ce3de32d8fc0577fee8354552d2962ce
This commit is contained in:
Goutham Pacha Ravi 2024-05-07 17:13:44 -07:00
parent a67b526453
commit 6169bfacf8
9 changed files with 59 additions and 5 deletions

View File

@ -1,3 +1,4 @@
sphinxcontrib.datatemplates
openstackdocstheme>=2.2.1 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
Pillow>=2.4.0 # PIL License Pillow>=2.4.0 # PIL License

View File

@ -32,6 +32,7 @@ sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts'))
extensions = [ extensions = [
'sphinx.ext.extlinks', 'sphinx.ext.extlinks',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinxcontrib.datatemplates',
'openstackdocstheme', 'openstackdocstheme',
'acs', 'acs',
'members', 'members',

View File

@ -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'] }} <https://opendev.org/{{ item['repo'] }}>`_
{%- endfor %}
{%- endfor %}

View File

@ -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'] }} <https://opendev.org/{{ line['repo'] }}>`_
{%- endfor %}

View File

@ -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 limited accountability is required, and SIGs do not have any required named
liaisons. liaisons.
SIGs can own git repositories and produce software, but that software will be SIGs :doc:`can own git repositories </reference/sig-repos>` and produce
considered add-on software to the main "OpenStack" software releases. Therefore 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 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 the openstack/releases repository. If a SIG does release any tooling or software
they are responsible for any release management/tagging needed. 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 It may delegate rights (and duties) to `TC working groups`_ (like the Election
officials which have a delegation for running elections). 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)
</reference/technical-committee-repos>` but does
not produce OpenStack deliverables by itself. not produce OpenStack deliverables by itself.
Board of Directors, Board committees and working groups Board of Directors, Board committees and working groups

View File

@ -16,13 +16,13 @@ Reference documents which need to be revised over time.
technical-vision technical-vision
upstream-investment-opportunities/index upstream-investment-opportunities/index
role-of-the-tc role-of-the-tc
technical-committee-repos
new-projects-requirements new-projects-requirements
new-language-requirements new-language-requirements
dropping-projects dropping-projects
licensing licensing
base-services base-services
user-committee-charter user-committee-charter
working-groups
service-project-naming service-project-naming
project-testing-interface project-testing-interface
irc irc
@ -31,6 +31,9 @@ Reference documents which need to be revised over time.
Requirements for previously-used incubation/integration process <incubation-integration-requirements> Requirements for previously-used incubation/integration process <incubation-integration-requirements>
house-rules house-rules
comparison-of-official-group-structures comparison-of-official-group-structures
working-groups
Special Interest Groups <https://governance.openstack.org/sigs/>
sig-repos
tc-guide tc-guide
OpenStack-name-in-external-services OpenStack-name-in-external-services
election-exceptions election-exceptions

View File

@ -28,7 +28,8 @@ the TC to describe the community structure, systems, operating principles,
and values by creating and maintaining corresponding documentation. This is and values by creating and maintaining corresponding documentation. This is
done in the :doc:`Technical Committee charter <charter>`, done in the :doc:`Technical Committee charter <charter>`,
the `TC governance website`_ documents and other TC-maintained publications 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 <technical-committee-repos>`.
The TC is just one of the governance bodies more widely involved in The TC is just one of the governance bodies more widely involved in
OpenStack governance. An important part of its role is therefore to OpenStack governance. An important part of its role is therefore to

9
reference/sig-repos.rst Normal file
View File

@ -0,0 +1,9 @@
.. _sig-repos:
===============================
Repositories maintained by SIGs
===============================
.. datatemplate:yaml::
:source: sigs-repos.yaml
:template: ../../templates/sigs_repos_table.tmpl

View File

@ -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