Skip to content

Latest commit

 

History

History
 
 

generator

README.md

SIG Doc builder

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.

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:

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 three types of doc files:

sig-<sig-name>/README.md
wg-<working-group-name>/README.md
sig-list.md

For example, if a contributor has updated sig-cluster-lifecycle, the following files will be generated:

sig-cluster-lifecycle/README.md
sig-list.md

How to use

To (re)build documentation for all the SIGs in a go environment, run:

make generate

or to run this inside a docker container:

make generate-dockerized

To build docs for one SIG, run one of these commands:

make WHAT=sig-apps
make WHAT=cluster-lifecycle
make WHAT=wg-resource-management
make WHAT=container-identity

where the WHAT var refers to the directory being built.

Adding custom content to your README

If your SIG or WG wishes to add custom content, you can do so by placing it within the following code comments:

<!-- BEGIN CUSTOM CONTENT -->

<!-- END CUSTOM CONTENT -->

Anything inside these code comments are saved by the generator and appended to newly generated content. Updating any content outside this block, however, will be overwritten the next time the generator runs.

An example might be:

<!-- BEGIN CUSTOM CONTENT -->
## Upcoming SIG goals
- Do this
- Do that
<!-- END CUSTOM CONTENT -->