summaryrefslogtreecommitdiff
path: root/generator/sig_readme.tmpl
diff options
context:
space:
mode:
authorAaron Crickenberger <spiffxp@google.com>2019-08-08 11:43:00 -0700
committerAaron Crickenberger <spiffxp@google.com>2019-08-08 12:54:14 -0700
commitc8f1173de064b11ceb888aad26d1309fa7575d33 (patch)
tree7d4719b733a73730267be8893f8563ccd7b11ed6 /generator/sig_readme.tmpl
parent8fd3a9e856a5ee4c5a2e34018c75cfd9cee949b8 (diff)
Make subprojects linkable, move github teams under contacts
This commit only contains the generator changes for easier review The bulleted list of subprojects makes it impossible to link someone to specific info for a given subproject. Now, instead of linking someone to sig-testing#subprojects and asking them to scroll, I link them directly to sig-testing#kind. While I was at this, I made the main SIG/WG/UG/Committee contact info format match what is used for subprojects, specifically: - display the slack channel name - list github teams as part of contact info instead of in a table - use - instead of * for bullets I also removed subproject rendering from WGs, since WGs cannot own code, and added a link to the governance definition of what a subproject is.
Diffstat (limited to 'generator/sig_readme.tmpl')
-rw-r--r--generator/sig_readme.tmpl53
1 files changed, 25 insertions, 28 deletions
diff --git a/generator/sig_readme.tmpl b/generator/sig_readme.tmpl
index 734c1512..12ad5bb4 100644
--- a/generator/sig_readme.tmpl
+++ b/generator/sig_readme.tmpl
@@ -48,64 +48,61 @@ subprojects, and resolve cross-subproject technical issues and decisions.
{{- end }}
## Contact
-* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})
-* [Mailing list]({{.Contact.MailingList}})
+- Slack: [#{{.Contact.Slack}}](https://kubernetes.slack.com/messages/{{.Contact.Slack}})
+- [Mailing list]({{.Contact.MailingList}})
{{- if .Label }}
-* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2F{{.Label}})
+- [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2F{{.Label}})
{{- end }}
+{{- if .Contact.GithubTeams }}
+- GitHub Teams:
+{{- range .Contact.GithubTeams }}
+ - [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}}
+{{- end }}
+{{- end }}
+
{{- if .Subprojects }}
## Subprojects
-The following subprojects are owned by sig-{{.Label}}:
+The following [subprojects][subproject-definition] are owned by sig-{{.Label}}:
{{- range .Subprojects }}
-- **{{.Name}}**
+### {{.Name}}
{{- if .Description }}
- - Description: {{ trimSpace .Description }}
+{{ trimSpace .Description }}
{{- end }}
- - Owners:
+- **Owners:**
{{- range .Owners }}
- - {{.}}
+ - {{.}}
{{- end }}
{{- if .Contact }}
- - Contact
+- **Contact:**
{{- if .Contact.Slack }}
- - Slack: [#{{.Contact.Slack}}](https://kubernetes.slack.com/messages/{{.Contact.Slack}})
+ - Slack: [#{{.Contact.Slack}}](https://kubernetes.slack.com/messages/{{.Contact.Slack}})
{{- end }}
{{- if .Contact.MailingList }}
- - [Mailing List]({{.Contact.MailingList}})
+ - [Mailing List]({{.Contact.MailingList}})
{{- end }}
{{- if .Contact.GithubTeams }}
- - GitHub Teams:
+ - GitHub Teams:
{{- range .Contact.GithubTeams }}
- - [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }}({{.Description}}){{- end}}
+ - [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}}{{- end}}
{{- end }}
{{- end }}
{{- end }}
{{- if .Meetings }}
- - Meetings:
+- **Meetings:**
{{- range .Meetings }}
- - {{.Description}}: [{{.Day}}s at {{.Time}} {{.TZ}}]({{.URL}}) ({{.Frequency}}). [Convert to your timezone](http://www.thetimezoneconverter.com/?t={{.Time}}&tz={{.TZ | tzUrlEncode}}).
+ - {{.Description}}: [{{.Day}}s at {{.Time}} {{.TZ}}]({{.URL}}) ({{.Frequency}}). [Convert to your timezone](http://www.thetimezoneconverter.com/?t={{.Time}}&tz={{.TZ | tzUrlEncode}}).
{{- if .ArchiveURL }}
- - [Meeting notes and Agenda]({{.ArchiveURL}}).
+ - [Meeting notes and Agenda]({{.ArchiveURL}}).
{{- end }}
{{- if .RecordingsURL }}
- - [Meeting recordings]({{.RecordingsURL}}).
+ - [Meeting recordings]({{.RecordingsURL}}).
{{- end }}
{{- end }}
{{- end }}
{{- end }}
{{- end }}
-{{ if .Contact.GithubTeams }}
-## GitHub Teams
-
-The below teams can be mentioned on issues and PRs in order to get attention from the right people.
-Note that the links to display team membership will only work if you are a member of the org.
-| Team Name | Details | Description |
-| --------- |:-------:| ----------- |
-{{- range .Contact.GithubTeams }}
-| @kubernetes/{{.Name}} | [link](https://github.com/orgs/kubernetes/teams/{{.Name}}) | {{.Description}} |
-{{- end }}
-{{ end }}
+[subproject-definition]: https://github.com/kubernetes/community/blob/master/governance.md#subprojects