kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Kubernetes Submit Queue 2017-10-13 10:06:58 -07:00 committed by GitHub
parent e7d035d628 d9682749f9
commit 5bd42a9126
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
generator/README.md
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: accompanying documentation. This takes the format of two types of doc file:
``` ```
./sig-<sig-name>/README.md sig-<sig-name>/README.md
./wg-<working-group-name>/README.md wg-<working-group-name>/README.md
./sig-list.md sig-list.md
``` ```
For example, if a contributor has updated `sig-cluster-lifecycle`, the For example, if a contributor has updated `sig-cluster-lifecycle`, the
following files will be generated: following files will be generated:
``` ```
./sig-cluster-lifecycle/README.md sig-cluster-lifecycle/README.md
./sig-list.md sig-list.md
``` ```
## How to use ## How to use
@ -30,7 +30,7 @@ To (re)build documentation for all the SIGs, run these commands:
make all make all
``` ```
To build docs for one SIG, run one these commands: To build docs for one SIG, run one of these commands:
```bash ```bash
make WHAT=sig-apps make WHAT=sig-apps