diff options
| -rw-r--r-- | generator/committee_readme.tmpl | 60 | ||||
| -rw-r--r-- | generator/sig_readme.tmpl | 53 | ||||
| -rw-r--r-- | generator/ug_readme.tmpl | 21 | ||||
| -rw-r--r-- | generator/wg_readme.tmpl | 49 |
4 files changed, 75 insertions, 108 deletions
diff --git a/generator/committee_readme.tmpl b/generator/committee_readme.tmpl index d84bd2b5..68b5b893 100644 --- a/generator/committee_readme.tmpl +++ b/generator/committee_readme.tmpl @@ -32,55 +32,67 @@ The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name} ## Contact {{- if .Contact.Slack }} -* [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.PrivateMailingList }} -* Private Mailing List: {{.Contact.PrivateMailingList}} +- Private Mailing List: {{.Contact.PrivateMailingList}} {{- end }} {{- if .Label }} -* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/ug%2F{{.Label}}) +- [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/committee%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 the {{.Name}} Committee: +The following [subprojects][subproject-definition] are owned by the {{.Name}} Committee: {{- range .Subprojects }} -- **{{.Name}}** +### {{.Name}} {{- if .Description }} - - Description: {{ trimSpace .Description }} +{{ trimSpace .Description }} {{- end }} - - Owners: +- **Owners:** {{- range .Owners }} - - {{.}} + - {{.}} +{{- end }} +{{- if .Contact }} +- **Contact:** +{{- if .Contact.Slack }} + - Slack: [#{{.Contact.Slack}}](https://kubernetes.slack.com/messages/{{.Contact.Slack}}) +{{- end }} +{{- if .Contact.MailingList }} + - [Mailing List]({{.Contact.MailingList}}) +{{- end }} +{{- if .Contact.GithubTeams }} + - GitHub Teams: +{{- range .Contact.GithubTeams }} + - [@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 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 diff --git a/generator/ug_readme.tmpl b/generator/ug_readme.tmpl index 9ec0d4db..4062128e 100644 --- a/generator/ug_readme.tmpl +++ b/generator/ug_readme.tmpl @@ -36,21 +36,14 @@ The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name} {{- 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/ug%2F{{.Label}}) +- [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/ug%2F{{.Label}}) {{- 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 | -| --------- |:-------:| ----------- | +{{- if .Contact.GithubTeams }} +- GitHub Teams: {{- range .Contact.GithubTeams }} -| @kubernetes/{{.Name}} | [link](https://github.com/orgs/kubernetes/teams/{{.Name}}) | {{.Description}} | + - [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}} +{{- end }} {{- end }} -{{ end }} diff --git a/generator/wg_readme.tmpl b/generator/wg_readme.tmpl index e1c22df3..0fc7ff47 100644 --- a/generator/wg_readme.tmpl +++ b/generator/wg_readme.tmpl @@ -42,49 +42,14 @@ The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name} {{- 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/wg%2F{{.Label}}) +- [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/wg%2F{{.Label}}) {{- end }} -{{- if .Subprojects }} - -## Subprojects - -The following subprojects are owned by wg-{{.Label}}: - -{{- range .Subprojects }} -- **{{.Name}}** -{{- if .Description }} - - Description: {{ .Description }} -{{- end }} - - Owners: -{{- range .Owners }} - - {{.}} -{{- end }} -{{- if .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}}). -{{- if .ArchiveURL }} - - [Meeting notes and Agenda]({{.ArchiveURL}}). -{{- end }} -{{- if .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 | -| --------- |:-------:| ----------- | +{{- if .Contact.GithubTeams }} +- GitHub Teams: {{- range .Contact.GithubTeams }} -| @kubernetes/{{.Name}} | [link](https://github.com/orgs/kubernetes/teams/{{.Name}}) | {{.Description}} | + - [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}} +{{- end }} {{- end }} -{{ end }} |