diff options
| author | Nikhita Raghunath <nikitaraghunath@gmail.com> | 2018-01-18 16:26:07 +0530 |
|---|---|---|
| committer | Nikhita Raghunath <nikitaraghunath@gmail.com> | 2018-01-18 16:26:07 +0530 |
| commit | 0ee56cdd88bf712999eb7c3876998282c0449106 (patch) | |
| tree | f34c6f47d33ec797286dbe4f1ac3b64e368defaa /generator | |
| parent | 8ab61ca524e305ace6e01a7182c9683717b1b1ff (diff) | |
generator: add google groups for github teams
Diffstat (limited to 'generator')
| -rw-r--r-- | generator/README.md | 13 | ||||
| -rw-r--r-- | generator/app.go | 2 | ||||
| -rw-r--r-- | generator/sig_readme.tmpl | 10 |
3 files changed, 18 insertions, 7 deletions
diff --git a/generator/README.md b/generator/README.md index 0f09eb0f..b00c8f1b 100644 --- a/generator/README.md +++ b/generator/README.md @@ -2,11 +2,18 @@ This folder contains scripts to automatically generate documentation about the different Special Interest Groups (SIGs) of Kubernetes. The authoritative -source for SIG information is the `sigs.yaml` file in the project root. All -updates must be done there. +source for SIG information is the [`sigs.yaml`](/sigs.yaml) file in the project root. +All updates must be done there. The schema for this file should be self explanatory. However, if you need to see all the options check out the generator code in `app.go`. +The documentation follows a template and uses the values from [`sigs.yaml`](/sigs.yaml): + +- Header: [`header.tmpl`](header.tmpl) +- List: [`list.tmpl`](list.tmpl) +- SIG README: [`sig_readme.tmpl`](sig_readme.tmpl) +- WG README: [`wg_readme.tmpl`](wg_readme.tmpl) + **Time Zone gotcha**: Time zones make everything complicated. And Daylight Savings time makes it even more complicated. @@ -16,7 +23,7 @@ Practically, that means US pacific time must be `PT (Pacific Time)`. `PT` isn't good enough, unfortunately. When an update happens to the this file, the next step is generate the -accompanying documentation. This takes the format of two types of doc file: +accompanying documentation. This takes the format of three types of doc files: ``` sig-<sig-name>/README.md diff --git a/generator/app.go b/generator/app.go index da75b16c..e7694b5b 100644 --- a/generator/app.go +++ b/generator/app.go @@ -142,7 +142,7 @@ func getExistingContent(path string) (string, error) { return strings.Join(captured, "\n"), nil } -var funcMap template.FuncMap = template.FuncMap{ +var funcMap = template.FuncMap{ "tzUrlEncode": tzUrlEncode, } diff --git a/generator/sig_readme.tmpl b/generator/sig_readme.tmpl index 2af46a52..c5aea6d4 100644 --- a/generator/sig_readme.tmpl +++ b/generator/sig_readme.tmpl @@ -31,9 +31,13 @@ Meeting recordings can be found [here]({{.MeetingRecordingsURL}}). 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 | -| --------- |:-------:| ----------- | +The google groups contain the archive of Github team notifications. +Mentioning a team on Github will CC its group. +Monitor these for Github activity if you are not a member of the team. + +| Team Name | Details | Google Groups | Description | +| --------- |:-------:|:-------------:| ----------- | {{- range .Contact.GithubTeams }} -| @kubernetes/{{.Name}} | [link](https://github.com/orgs/kubernetes/teams/{{.Name}}) | {{.Description}} | +| @kubernetes/{{.Name}} | [link](https://github.com/orgs/kubernetes/teams/{{.Name}}) | [link](https://groups.google.com/forum/#!forum/kubernetes-{{.Name}}) | {{.Description}} | {{- end }} {{ end }} |
