summaryrefslogtreecommitdiff
path: root/generator
diff options
context:
space:
mode:
authorAaron Crickenberger <spiffxp@gmail.com>2018-01-10 12:49:04 -0800
committerAaron Crickenberger <spiffxp@gmail.com>2018-02-07 16:11:54 -0700
commit170a99a651b57791156cf62d61a013bc51ebc661 (patch)
treee20b77ed41ce877a350197544fb44faa81519d08 /generator
parentee9d051a206064f82eaf0210fc4497ebdb6714e2 (diff)
Add strawman implementation of subprojects
A subproject is a one-to-many mapping of a name to a list of OWNERS urls. This allows for a subproject to be a single repo (eg: helm), or a subproject to be a list of multiple subdirectories across one or more repos (eg: workloads api) SIG meetings dedicated to a single subproject moved down to subproject meetings
Diffstat (limited to 'generator')
-rw-r--r--generator/app.go9
-rw-r--r--generator/sig_readme.tmpl29
2 files changed, 38 insertions, 0 deletions
diff --git a/generator/app.go b/generator/app.go
index d2f9f6aa..c2d0d448 100644
--- a/generator/app.go
+++ b/generator/app.go
@@ -83,6 +83,14 @@ type GithubTeams struct {
Description string
}
+// Subproject represenst a specific subproject owned by the group
+type Subproject struct {
+ Name string
+ Description string
+ Owners []string
+ Meetings []Meeting
+}
+
// Group represents either a Special Interest Group (SIG) or a Working Group (WG)
type Group struct {
Name string
@@ -92,6 +100,7 @@ type Group struct {
Leads []Lead
Meetings []Meeting
Contact Contact
+ Subprojects []Subproject
}
// DirName returns the directory that a group's documentation will be
diff --git a/generator/sig_readme.tmpl b/generator/sig_readme.tmpl
index 2b3582ef..ad500107 100644
--- a/generator/sig_readme.tmpl
+++ b/generator/sig_readme.tmpl
@@ -25,6 +25,35 @@
{{- if .Label }}
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2F{{.Label}})
{{- end }}
+{{- if .Subprojects }}
+
+## Subprojects
+
+The following subprojects are owned by this SIG:
+
+{{- 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