change webdoc and testdoc
This commit is contained in:
parent
b73782ce10
commit
264e770dcb
|
@ -88,10 +88,6 @@ module.exports = {
|
||||||
text: '完善文档',
|
text: '完善文档',
|
||||||
link: '/community/webdoc.html'
|
link: '/community/webdoc.html'
|
||||||
},
|
},
|
||||||
{
|
|
||||||
text: '测试文档'
|
|
||||||
link: '/community/testdoc.html'
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
text: '报告Bug',
|
text: '报告Bug',
|
||||||
link: '/community/bugreport.html'
|
link: '/community/bugreport.html'
|
||||||
|
@ -150,7 +146,6 @@ module.exports = {
|
||||||
'/community/': [
|
'/community/': [
|
||||||
['contrib','贡献代码'],
|
['contrib','贡献代码'],
|
||||||
['webdoc','完善文档'],
|
['webdoc','完善文档'],
|
||||||
['testdoc','测试文档'],
|
|
||||||
['bugreport','报告Bug']
|
['bugreport','报告Bug']
|
||||||
],
|
],
|
||||||
'/about/': [
|
'/about/': [
|
||||||
|
|
Binary file not shown.
|
@ -1,4 +0,0 @@
|
||||||
# test
|
|
||||||
|
|
||||||
|
|
||||||
## test
|
|
|
@ -89,72 +89,11 @@ cd xuos-web
|
||||||
yarn add -D vuepress
|
yarn add -D vuepress
|
||||||
```
|
```
|
||||||
|
|
||||||
## 工作阶段
|
## 修改测试
|
||||||
|
|
||||||
### 步骤6 : fetch
|
### 步骤6 : 修改测试
|
||||||
|
|
||||||
从 **upstream(xuos/xiuos)** fetch 代码到本地
|
修改你想要修改的内容,修改完之后启动测试
|
||||||
|
|
||||||
```
|
|
||||||
git fetch upstream
|
|
||||||
```
|
|
||||||
|
|
||||||
### 步骤7 : branch
|
|
||||||
|
|
||||||
为本次工作创建一个分支,命名为 `develop`
|
|
||||||
|
|
||||||
```
|
|
||||||
git checkout -b develop upstream/master
|
|
||||||
```
|
|
||||||
|
|
||||||
### 步骤8 : work, commit & commit
|
|
||||||
|
|
||||||
此时就可以在该分支下工作了, 不断修改代码,不断 commit
|
|
||||||
|
|
||||||
```
|
|
||||||
git add .
|
|
||||||
|
|
||||||
git commit -m "your commit message"
|
|
||||||
```
|
|
||||||
|
|
||||||
### 步骤9 : push & push
|
|
||||||
|
|
||||||
如果经过测试,您觉得在本地完成了代码工作,您就可以将代码推送到您自己的服务器端的仓库中了。
|
|
||||||
```
|
|
||||||
git push origin develop
|
|
||||||
```
|
|
||||||
|
|
||||||
push到自己的服务器端库中后,就可以准备创建`合并请求(Pull Request)`了。
|
|
||||||
|
|
||||||
### 步骤10 : fetch
|
|
||||||
|
|
||||||
从XiUOS的主库, 即 upstream 中, fetch 最新的代码
|
|
||||||
|
|
||||||
```
|
|
||||||
git fetch upstream
|
|
||||||
```
|
|
||||||
|
|
||||||
### 步骤11 : merge
|
|
||||||
|
|
||||||
将upstream 上最新的代码合并到你的当前工作分支
|
|
||||||
|
|
||||||
```
|
|
||||||
git merge upstream/master
|
|
||||||
```
|
|
||||||
|
|
||||||
此时请确保本地您位于工作分支。如果合并过程有冲突,您要负责解决冲突,并提交。
|
|
||||||
|
|
||||||
### 步骤12 : push
|
|
||||||
|
|
||||||
将消解了冲突的最新本地代码,推送到个人服务器端仓库的develop分支。
|
|
||||||
|
|
||||||
```
|
|
||||||
git push origin develop
|
|
||||||
```
|
|
||||||
|
|
||||||
## 测试阶段
|
|
||||||
|
|
||||||
### 步骤13 : 终端测试
|
|
||||||
```bash
|
```bash
|
||||||
yarn dev
|
yarn dev
|
||||||
```
|
```
|
||||||
|
@ -168,6 +107,70 @@ yarn build
|
||||||
|
|
||||||
可在 docs/.vuepress/dist 中生成编译后的html页面
|
可在 docs/.vuepress/dist 中生成编译后的html页面
|
||||||
|
|
||||||
|
|
||||||
|
## 上传阶段
|
||||||
|
|
||||||
|
### 步骤7 : fetch
|
||||||
|
|
||||||
|
从 **upstream(xuos/xiuos)** fetch 代码到本地
|
||||||
|
|
||||||
|
```
|
||||||
|
git fetch upstream
|
||||||
|
```
|
||||||
|
|
||||||
|
### 步骤8 : branch
|
||||||
|
|
||||||
|
为本次工作创建一个分支,命名为 `develop`
|
||||||
|
|
||||||
|
```
|
||||||
|
git checkout -b develop upstream/master
|
||||||
|
```
|
||||||
|
|
||||||
|
### 步骤9 : work, commit & commit
|
||||||
|
|
||||||
|
此时就可以在该分支下工作了, 不断修改代码,不断 commit
|
||||||
|
|
||||||
|
```
|
||||||
|
git add .
|
||||||
|
|
||||||
|
git commit -m "your commit message"
|
||||||
|
```
|
||||||
|
|
||||||
|
### 步骤10 : push & push
|
||||||
|
|
||||||
|
如果经过测试,您觉得在本地完成了代码工作,您就可以将代码推送到您自己的服务器端的仓库中了。
|
||||||
|
```
|
||||||
|
git push origin develop
|
||||||
|
```
|
||||||
|
|
||||||
|
push到自己的服务器端库中后,就可以准备创建`合并请求(Pull Request)`了。
|
||||||
|
|
||||||
|
### 步骤11 : fetch
|
||||||
|
|
||||||
|
从XiUOS的主库, 即 upstream 中, fetch 最新的代码
|
||||||
|
|
||||||
|
```
|
||||||
|
git fetch upstream
|
||||||
|
```
|
||||||
|
|
||||||
|
### 步骤12 : merge
|
||||||
|
|
||||||
|
将upstream 上最新的代码合并到你的当前工作分支
|
||||||
|
|
||||||
|
```
|
||||||
|
git merge upstream/master
|
||||||
|
```
|
||||||
|
|
||||||
|
此时请确保本地您位于工作分支。如果合并过程有冲突,您要负责解决冲突,并提交。
|
||||||
|
|
||||||
|
### 步骤13 : push
|
||||||
|
|
||||||
|
将消解了冲突的最新本地代码,推送到个人服务器端仓库的develop分支。
|
||||||
|
|
||||||
|
```
|
||||||
|
git push origin develop
|
||||||
|
```
|
||||||
|
|
||||||
## 合并阶段
|
## 合并阶段
|
||||||
|
|
||||||
### 步骤14 : 合并请求(pull request)
|
### 步骤14 : 合并请求(pull request)
|
||||||
|
@ -208,16 +211,38 @@ vim config.js
|
||||||
找到'社区',在其中子目录添加
|
找到'社区',在其中子目录添加
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
text:'测试文档'
|
text:'测试文档',
|
||||||
link:'/community/testdoc.html'
|
link:'/community/testdoc.html'
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
转到目录并添加:
|
找到'/community',在其子目录添加
|
||||||
|
```
|
||||||
|
[
|
||||||
|
['testdoc','测试文档'],
|
||||||
|
],
|
||||||
|
```
|
||||||
|
转到目录创建testdoc.md文件:
|
||||||
```
|
```
|
||||||
cd xuos-web/docs/community
|
cd xuos-web/docs/community
|
||||||
vim testdoc.md
|
vim testdoc.md
|
||||||
```
|
```
|
||||||
在文件testdoc.md中增加目标内容
|
在文件testdoc.md中增加目标内容,如:test
|
||||||
|
|
||||||
|
查看网站修改情况
|
||||||
|
```
|
||||||
|
yarn dev
|
||||||
|
```
|
||||||
|
登录网站:http://localhost:8080/即可,查看确认无误之后
|
||||||
|
|
||||||
|
在目录xuos-web/docs/下
|
||||||
|
```
|
||||||
|
git add community/testdoc.md
|
||||||
|
git commit -m "change testdoc"
|
||||||
|
git fetch upstream
|
||||||
|
git merge upstream/master
|
||||||
|
git push origin BranchName
|
||||||
|
```
|
||||||
|
最终合并到目标仓库中完成修改
|
||||||
|
|
||||||
|
|
||||||
### 增加图片
|
### 增加图片
|
||||||
|
|
Loading…
Reference in New Issue