Skip to content

Commit

Permalink
docs: Document Contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
kl7sn committed Jan 6, 2023
1 parent 147a54a commit 5812f1f
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/apis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
push:
branches:
- 'master'
- 'feature/docker-ci'
# - 'feature/docker-ci'

jobs:
updateAPI:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
push:
branches:
- 'master'
- 'feature/docker-ci'
# - 'feature/docker-ci'

jobs:
deploy:
Expand Down
8 changes: 3 additions & 5 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,10 @@ cd ./clickvisual-${latest} && ./clickvisual --config config/default.toml
# 默认登录密码: clickvisual
```

## 文档贡献

## Main Tasks

## Bugs or features

如果需要提交 Bug,可以点击 [这里](https://github.com/clickvisual/clickvisual/issues)
如果你要参与 [https://clickvisual.gocn.vip](https://clickvisual.gocn.vip) 文档更新的活动
可以参考该文档 [https://github.com/clickvisual/clickvisual/tree/master/docs](https://github.com/clickvisual/clickvisual/tree/master/docs)

## 加入我们

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,10 @@ cd ./clickvisual-${latest} && ./clickvisual -config config/default.toml
# login password: clickvisual
```

## Document Contribution

## Main Tasks

## Bugs or Features

If you want to report a bug or request for a feature, create a issue [here](https://github.com/clickvisual/clickvisual/issues).
If you want to participate in [https://clickvisual.gocn.vip](https://clickvisual.gocn.vip) document updating activities
Please refer to this document [https://github.com/clickvisual/clickvisual/tree/master/docs](https://github.com/clickvisual/clickvisual/tree/master/docs)

## Join Us

Expand Down
11 changes: 11 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## 本地调试

进入当前目录后执行 `sodu npm install`

本地调试执行 `vuepress dev docs`

## 合并推送

提交前需要确认 `npm run docs:build` 没有报错

成功合并后会自动更新到 [https://clickvisual.gocn.vip/](https://clickvisual.gocn.vip/)

0 comments on commit 5812f1f

Please sign in to comment.