Community: SIG README formats are inconsistent and sometimes incomplete

[jamiehannaford]

Would it be possible to standardise a template for all SIGs to use in their READMEs? Something like:

# Title 

Mission statement

## Leads

## Contact us

## Meetings 

## Other links 

I'd be willing to take this on but wanted some feedback first.

[castrojo]

I'm wondering if a template would work? So instead of manually updating READMEs we could have one template with the appropriate metadata that could just autogenerate the READMEs for each SIG for consistency and drop them in the right directory. And then as a bonus also generate one-big-page to replace the list of SIGs (which are updated by hand) and also generate a one-line snippet for SIG leads to use as a topic in the slack channel.

I've been in the situation before where a SIG meeting was listed differently in slack, on the SIG page, and the list-of-SIGs page, so perhaps thinking about a single source of truth for all the sig metadata and then autogenerating the rest would be worth investigating?

[jamiehannaford]

@castrojo I like that idea. Where would be best to store the SIG-specific info? Perhaps a JSON, YAML or MD file, like so?

sigs:
  sig-openstack: 
     mission-statement: >
       This is the community page of the Kubernetes OpenStack SIG, a special interest group
       coordinating the cross-community efforts of the OpenStack and Kubernetes communities. 
     leads:
     - name: Foo 
       github: @foo
     - name: Bar
       email: [email protected]
     meetings:
     - day: monday
       utc: 0900
     - day: wednesday
       utc: 2100
     contact:
       slack: #sig-openstack
       mailing-list: ...
     other-links:
     - google.com
     - openstack.org

[castrojo]

I think a YAML file to match everything else makes sense, though it's probably prudent to see what other people think.

Meetings would need meeting_url for the zoom hangout, and perhaps a meeting_archive_url for the groups that maintain youtube playlists of their meetings, looking good!