diff options
| author | Nikhita Raghunath <nikitaraghunath@gmail.com> | 2019-03-15 16:33:11 +0530 |
|---|---|---|
| committer | Nikhita Raghunath <nikitaraghunath@gmail.com> | 2019-03-15 18:13:12 +0530 |
| commit | 347f7d07d35979b952d52b1c4b234f3761dab2eb (patch) | |
| tree | 163664b42440a5bfe0ee77386f933fc5fde84ca2 /generator/README.md | |
| parent | 010ab0ff52c5e4e33bde1a5a458d674f7840e9e2 (diff) | |
generator: add support for committees
Since committees can have private mailing lists, this commit
also adds a new field for specifying private mailing lists
in the "Contacts" section.
Diffstat (limited to 'generator/README.md')
| -rw-r--r-- | generator/README.md | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/generator/README.md b/generator/README.md index 2c5ef157..de68d18e 100644 --- a/generator/README.md +++ b/generator/README.md @@ -1,7 +1,8 @@ # SIG Doc builder This folder contains scripts to automatically generate documentation about the -different Special Interest Groups (SIGs) and Working Groups (WGs) of Kubernetes. The authoritative +different Special Interest Groups (SIGs), Working Groups (WGs), +User Groups (UGs) and Committees of Kubernetes. The authoritative source for SIG information is the [`sigs.yaml`](/sigs.yaml) file in the project root. All updates must be done there. @@ -14,6 +15,7 @@ The documentation follows a template and uses the values from [`sigs.yaml`](/sig - SIG README: [`sig_readme.tmpl`](sig_readme.tmpl) - WG README: [`wg_readme.tmpl`](wg_readme.tmpl) - UG README: [`ug_readme.tmpl`](ug_readme.tmpl) +- Committee README: [`committee_readme.tmpl`](committee_readme.tmpl) **Time Zone gotcha**: Time zones make everything complicated. @@ -24,12 +26,13 @@ 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 to generate the -accompanying documentation. This takes the format of three types of doc files: +accompanying documentation. This takes the format of the following types of doc files: ``` sig-<sig-name>/README.md wg-<working-group-name>/README.md ug-<user-group-name>/README.md +committee-<committee-name>/README.md sig-list.md ``` @@ -64,9 +67,11 @@ make WHAT=container-identity where the `WHAT` var refers to the directory being built. -## Adding custom content to your README +## Adding custom content -If your SIG or WG wishes to add custom content, you can do so by placing it within +### README + +If your SIG, WG, UG or Committee wishes to add custom content, you can do so by placing it within the following code comments: ```markdown @@ -88,3 +93,14 @@ An example might be: - Do that <!-- END CUSTOM CONTENT --> ``` + +### OWNERS_ALIASES + +Similarly, custom aliases can be added in the `OWNERS_ALIASES` file by placing +it within the following code comments: + +```yaml +## BEGIN CUSTOM CONTENT + +## END CUSTOM CONTENT +``` |