summaryrefslogtreecommitdiff
path: root/generator
diff options
context:
space:
mode:
authorChristoph Blecker <admin@toph.ca>2018-01-24 12:07:28 -0800
committerChristoph Blecker <admin@toph.ca>2018-01-24 12:07:28 -0800
commit0686661aed2483a07c163ee900982b7414972533 (patch)
tree0ae66f134188e2baac002bd5b153849c00bcdc59 /generator
parent9baebba1970b482a6d59d1e205a3e49346deccc1 (diff)
Modify sig docs generator to handle multiple meetings
Diffstat (limited to 'generator')
-rw-r--r--generator/app.go29
-rw-r--r--generator/list.tmpl4
-rw-r--r--generator/sig_readme.tmpl14
-rw-r--r--generator/wg_readme.tmpl14
4 files changed, 31 insertions, 30 deletions
diff --git a/generator/app.go b/generator/app.go
index e7694b5b..79e08cd3 100644
--- a/generator/app.go
+++ b/generator/app.go
@@ -58,10 +58,14 @@ type Lead struct {
// Meeting represents a regular meeting for a group.
type Meeting struct {
- Day string
- Time string
- TZ string `yaml:"tz"`
- Frequency string
+ Description string
+ Day string
+ Time string
+ TZ string
+ Frequency string
+ URL string
+ ArchiveURL string `yaml:"archive_url"`
+ RecordingsURL string `yaml:"recordings_url"`
}
// Contact represents the various contact points for a group.
@@ -79,16 +83,13 @@ type GithubTeams struct {
// Group represents either a Special Interest Group (SIG) or a Working Group (WG)
type Group struct {
- Name string
- Dir string
- MissionStatement string `yaml:"mission_statement"`
- Label string
- Leads []Lead
- Meetings []Meeting
- MeetingURL string `yaml:"meeting_url"`
- MeetingArchiveURL string `yaml:"meeting_archive_url"`
- MeetingRecordingsURL string `yaml:"meeting_recordings_url"`
- Contact Contact
+ Name string
+ Dir string
+ MissionStatement string `yaml:"mission_statement"`
+ Label string
+ Leads []Lead
+ Meetings []Meeting
+ Contact Contact
}
// DirName returns the directory that a group's documentation will be
diff --git a/generator/list.tmpl b/generator/list.tmpl
index 38ddc0e1..17ece912 100644
--- a/generator/list.tmpl
+++ b/generator/list.tmpl
@@ -16,7 +16,7 @@ When the need arises, a [new SIG can be created](sig-creation-procedure.md)
| Name | Label | Leads | Contact | Meetings |
|------|--------|-------|---------|----------|
{{- range .Sigs}}
-|[{{.Name}}]({{.Dir}}/README.md)|{{.Label}}|{{range .Leads}}* [{{.Name}}](https://github.com/{{.GitHub}}){{if .Company}}, {{.Company}}{{end}}<br>{{end}}|* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})<br>* [Mailing List]({{.Contact.MailingList}})|{{ $save := . }}{{range .Meetings}}* [{{.Day}}s at {{.Time}} {{.TZ}} ({{.Frequency}})]({{$save.MeetingURL}})<br>{{end}}
+|[{{.Name}}]({{.Dir}}/README.md)|{{.Label}}|{{range .Leads}}* [{{.Name}}](https://github.com/{{.GitHub}}){{if .Company}}, {{.Company}}{{end}}<br>{{end}}|* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})<br>* [Mailing List]({{.Contact.MailingList}})|{{ $save := . }}{{range .Meetings}}* {{.Description}}: [{{.Day}}s at {{.Time}} {{.TZ}} ({{.Frequency}})]({{.URL}})<br>{{end}}
{{- end }}
### Master Working Group List
@@ -24,5 +24,5 @@ When the need arises, a [new SIG can be created](sig-creation-procedure.md)
| Name | Organizers | Contact | Meetings |
|------|------------|---------|----------|
{{- range .WorkingGroups}}
-|[{{.Name}}]({{.Dir}}/README.md)|{{range .Leads}}* [{{.Name}}](https://github.com/{{.GitHub}}){{if .Company}}, {{.Company}}{{end}}<br>{{end}}|* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})<br>* [Mailing List]({{.Contact.MailingList}})|{{ $save := . }}{{range .Meetings}}* [{{.Day}}s at {{.Time}} {{.TZ}} ({{.Frequency}})]({{$save.MeetingURL}})<br>{{end}}
+|[{{.Name}}]({{.Dir}}/README.md)|{{range .Leads}}* [{{.Name}}](https://github.com/{{.GitHub}}){{if .Company}}, {{.Company}}{{end}}<br>{{end}}|* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})<br>* [Mailing List]({{.Contact.MailingList}})|{{ $save := . }}{{range .Meetings}}* {{.Description}}: [{{.Day}}s at {{.Time}} {{.TZ}} ({{.Frequency}})]({{.URL}})<br>{{end}}
{{- end }}
diff --git a/generator/sig_readme.tmpl b/generator/sig_readme.tmpl
index c5aea6d4..2b3582ef 100644
--- a/generator/sig_readme.tmpl
+++ b/generator/sig_readme.tmpl
@@ -2,18 +2,18 @@
# {{.Name}} SIG
{{ .MissionStatement }}
-## Meetings
+{{ if .Meetings }}## Meetings
{{- range .Meetings }}
-* [{{.Day}}s at {{.Time}} {{.TZ}}]({{$.MeetingURL}}) ({{.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}}).
{{- end }}
-
-{{ if .MeetingArchiveURL -}}
-Meeting notes and Agenda can be found [here]({{.MeetingArchiveURL}}).
+{{- if .RecordingsURL }}
+ * [Meeting recordings]({{.RecordingsURL}}).
{{- end }}
-{{ if .MeetingRecordingsURL -}}
-Meeting recordings can be found [here]({{.MeetingRecordingsURL}}).
{{- end }}
+{{ end -}}
## Leads
{{- range .Leads }}
* {{.Name}} (**[@{{.GitHub}}](https://github.com/{{.GitHub}})**){{if .Company}}, {{.Company}}{{end}}
diff --git a/generator/wg_readme.tmpl b/generator/wg_readme.tmpl
index cd9cc2fd..5cd75e66 100644
--- a/generator/wg_readme.tmpl
+++ b/generator/wg_readme.tmpl
@@ -2,18 +2,18 @@
# {{.Name}} Working Group
{{ .MissionStatement }}
-## Meetings
+{{ if .Meetings }}## Meetings
{{- range .Meetings }}
-* [{{.Day}}s at {{.Time}} {{.TZ}}]({{$.MeetingURL}}) ({{.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}}).
{{- end }}
-
-{{ if .MeetingArchiveURL -}}
-Meeting notes and Agenda can be found [here]({{.MeetingArchiveURL}}).
+{{- if .RecordingsURL }}
+ * [Meeting recordings]({{.RecordingsURL}}).
{{- end }}
-{{ if .MeetingRecordingsURL -}}
-Meeting recordings can be found [here]({{.MeetingRecordingsURL}}).
{{- end }}
+{{ end -}}
## Organizers
{{- range .Leads }}
* {{.Name}} (**[@{{.GitHub}}](https://github.com/{{.GitHub}})**){{if .Company}}, {{.Company}}{{end}}