diff options
Diffstat (limited to 'generator/README.md')
| -rw-r--r-- | generator/README.md | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/generator/README.md b/generator/README.md index c522ec97..3fd2230e 100644 --- a/generator/README.md +++ b/generator/README.md @@ -1,14 +1,26 @@ # SIG Doc builder -This script will generate the following documentation files: +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. + +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: ``` -sig-*/README.md -wg-*/README.md -sig-list.md +./sig-<sig-name>/README.md +./wg-<working-group-name>/README.md +./sig-list.md ``` -Based off the `sigs.yaml` metadata file. +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 |