Modify the directory in generator

Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
This commit is contained in:
yuexiao-wang 2017-10-12 20:20:08 +08:00
parent 4f4560659c
commit d9682749f9
1 changed files with 6 additions and 6 deletions

View File

@ -9,17 +9,17 @@ 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-<sig-name>/README.md
./wg-<working-group-name>/README.md
./sig-list.md
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
sig-cluster-lifecycle/README.md
sig-list.md
```
## How to use
@ -30,7 +30,7 @@ To (re)build documentation for all the SIGs, run these commands:
make all
```
To build docs for one SIG, run one these commands:
To build docs for one SIG, run one of these commands:
```bash
make WHAT=sig-apps