simplify usage, add docker file, add readme #22
Conversation
Address issues: wangkuiyi#10
| RUN cd / && wget https://get.docker.com/builds/Linux/x86_64/docker-1.11.0.tgz && tar -xvf docker-1.11.0.tgz && mv /docker/docker /usr/bin/ && rm -rf /docker | ||
| RUN mkdir /data | ||
| ADD . /gopath/src/github.com/wangkuiyi/ci | ||
| RUN cd /gopath/src/github.com/wangkuiyi/ci/ && GOPATH=/gopath go get ./... && GOPATH=/gopath CGO_ENABLED=0 go build && cp ci / && rm -rf /gopath |
There was a problem hiding this comment.
将来我们把ci这个repo从wangkiuiyi 迁移到 paddlepaddle之后，这里需要修改一下url。
现在不用修改。只是记录一下。
| "github.com/gorilla/mux" | ||
| "github.com/urfave/negroni" | ||
| "github.com/wangkuiyi/ci/db" | ||
| "github.com/wangkuiyi/ci/github" |
| @@ -0,0 +1,120 @@ | |||
| # Get code | |||
There was a problem hiding this comment.
# 标志的是顶级head，也就是标题。这里可以是 # ci: A Distributed Continuous Integration System
| go get github.com/wangkuiyi/ci | ||
| cd $GOPATH/github.com/wangkuiyi/ci | ||
| ``` | ||
| # Build |
There was a problem hiding this comment.
上面的 # Get Code 和这里的 # Build 作为三级headings比较好， ### Get Code 和 ### Build from Source Code。二级目录叫 # Build and Install 比较好。
There was a problem hiding this comment.
好的，请问标题的名称什么时候首字母大写？为什么是### Build from Source Code，而不是### Build From Source Code，或者### Build from source code
There was a problem hiding this comment.
因为from是介词，在标题里如果不是第一个单词，不用capitalize。
我一般用这个在线工具验证 http://www.titlecapitalization.com/
| ``` | ||
| docker build . -t ci | ||
| ``` | ||
| ## Build on a normal machine |
There was a problem hiding this comment.
## Build on a normal machine ==> ### Update Go Dependencies
go get ./... ==> go get -u ./...
There was a problem hiding this comment.
这里跟#### Build docker image是并列的关系，感觉改成#### Build Natively更合适？
There was a problem hiding this comment.
或者我们列两种方式: build from source code 和 build Docker images ?
| filename: ci.sh | ||
| endpoint: http://87b93f06.ngrok.io | ||
| ``` | ||
| ## Start ci server |
| endpoint: http://87b93f06.ngrok.io | ||
| ``` | ||
| ## Start ci server | ||
| ### Run using docker image |
There was a problem hiding this comment.
Run using docker image ==> In Docker Containers
There was a problem hiding this comment.
改成了### Run In Docker Container，没有用复数(s)，因为我感觉是单个container。
| ci server template directory (default "/templates") | ||
| ``` | ||
|
|
||
| # Generate personal access token |
| ci server template directory (default "/templates") | ||
| ``` | ||
|
|
||
| # Generate personal access token |
There was a problem hiding this comment.
Generate personal access token ==> Generation Github Personal Access Token
There was a problem hiding this comment.
Generation Github Personal Access Token感觉不是很通顺，改成了Github Personal Access Token Generation
| cp ci_yaml_dir/ci.yaml . | ||
| docker run -p 8000:8000 -v $(pwd):/data -v /var/run/docker.sock:/var/run/docker.sock ci | ||
| ``` | ||
| #### Explanation: -v /var/run/docker.sock:/var/run/docker.sock |
There was a problem hiding this comment.
这几个explanations是不是用 enumerated list 更好？
|
@wangkuiyi 大多数的按建议改了，有些我觉得改了之后不是很通顺或者跟我原意不一致的我comment了。请见comment。 |
|
关于介词在标题里的capitalization，我回复在 #22 (comment) 了。 LGTM! |
|
@wangkuiyi 明白了，谢谢！又按你的建议修改了下。另外把所有标题都到http://www.titlecapitalization.com/跑了一遍。 |
Fixes #10