kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2559 from shavidissa/patch-2 

Copy-edit pass
This commit is contained in:
k8s-ci-robot 2018-08-20 11:07:00 -07:00 committed by GitHub
parent f85f834cd0 fc9fe8b0c6
commit 1f69c92304
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
generator/README.md
View File

@ -1,11 +1,11 @@
# SIG Doc builder # SIG Doc builder
This folder contains scripts to automatically generate documentation about the This folder contains scripts to automatically generate documentation about the
different Special Interest Groups (SIGs) of Kubernetes. The authoritative different Special Interest Groups (SIGs) and Working Groups (WGs) of Kubernetes. The authoritative
source for SIG information is the [`sigs.yaml`](/sigs.yaml) file in the project root. source for SIG information is the [`sigs.yaml`](/sigs.yaml) file in the project root.
All updates must be done there. 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 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): The documentation follows a template and uses the values from [`sigs.yaml`](/sigs.yaml):
@ -17,12 +17,12 @@ The documentation follows a template and uses the values from [`sigs.yaml`](/sig
**Time Zone gotcha**: **Time Zone gotcha**:
Time zones make everything complicated. Time zones make everything complicated.
And Daylight Saving time makes it even more complicated. And Daylight Saving time makes it even more complicated.
Meetings are specified with a time zone and we generate a link to http://www.thetimezoneconverter.com/ so that people can easily convert it to their local time zone. Meetings are specified with a time zone and we generate a link to http://www.thetimezoneconverter.com/ so people can easily convert it to their local time zone.
To make this work you need to specify the time zone in a way that that web site recognizes. To make this work you need to specify the time zone in a way that the web site recognizes.
Practically, that means US pacific time must be `PT (Pacific Time)`. Practically, that means US pacific time must be `PT (Pacific Time)`.
`PT` isn't good enough, unfortunately. `PT` isn't good enough, unfortunately.
When an update happens to the this file, the next step is generate the 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 three types of doc files:
``` ```