diff options
| author | Kubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com> | 2017-10-13 10:06:58 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-13 10:06:58 -0700 |
| commit | 5bd42a9126ceebc44fd3630d4a531cd2ed76acac (patch) | |
| tree | 359a413573f8f71e50a11c84bfe1131377c12ece /generator | |
| parent | e7d035d628521fc55755c463196be4920cf9a4a9 (diff) | |
| parent | d9682749f99685ee3142ca65e61de1903670ce1c (diff) | |
Merge pull request #1178 from yuexiao-wang/clear-readme
Automatic merge from submit-queue.
Modify the path of markdown files in generator
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
The path of markdown files is incorrect in generator and we maybe use relative path.
Diffstat (limited to 'generator')
| -rw-r--r-- | generator/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/generator/README.md b/generator/README.md index 92340f19..3a2dd244 100644 --- a/generator/README.md +++ b/generator/README.md @@ -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 |