summaryrefslogtreecommitdiff
path: root/generator/README.md
diff options
context:
space:
mode:
authorJoe Beda <joe.github@bedafamily.com>2017-11-06 11:57:04 -0800
committerJoe Beda <joe.github@bedafamily.com>2017-11-06 13:35:52 -0800
commit1cc0e9748240fc2659ad2d80c610f54880121e16 (patch)
tree284def1109488b147dbbc6e27c5f6ea191176f20 /generator/README.md
parent56ddf9c24ae7e308e3cbd4cb9c3638d758c53709 (diff)
Make time zone explicit
Diffstat (limited to 'generator/README.md')
-rw-r--r--generator/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/generator/README.md b/generator/README.md
index 175d7c8f..0f09eb0f 100644
--- a/generator/README.md
+++ b/generator/README.md
@@ -5,6 +5,16 @@ 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.
+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`.
+
+**Time Zone gotcha**:
+Time zones make everything complicated.
+And Daylight Savings 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.
+To make this work you need to specify the time zone in a way that that web site recognizes.
+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: