diff --git a/docs/community/.contrib.md.swp b/docs/community/.contrib.md.swp deleted file mode 100644 index 7d1fb7b..0000000 Binary files a/docs/community/.contrib.md.swp and /dev/null differ diff --git a/docs/community/webdoc.md b/docs/community/webdoc.md index 10031b2..82bcbd7 100644 --- a/docs/community/webdoc.md +++ b/docs/community/webdoc.md @@ -4,7 +4,7 @@ 首先,从XiUOS主库中复刻一份到自己的个人空间。 假定您在Trustie的用户名为“panda” -## 步骤1:复刻 +### 步骤1:复刻 再在浏览器中打开XiUOS的项目首页[https://forgeplus.trustie.net/projects/xuos/xiuos](https://forgeplus.trustie.net/projects/xuos/xiuos), 点击右上角的"复刻" 按钮 这样您就在自己的个人空间中有了XiUOS的一个复刻代码库, 地址为 @@ -32,10 +32,66 @@ git clone https://git.trustie.net/panda/xiuos.git git remote add upstream https://git.trustie.net/xuos/xiuos.git # 禁止直接向 upstream 推送代码 git remote set-url --push upstream no_push +``` +### 步骤3 : 安装 yarn + +首先 + +```bash +curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - +echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list +``` + +然后 + +```bash +sudo apt update && sudo apt install yarn +``` + +具体参见[这里](https://classic.yarnpkg.com/en/docs/install/#debian-stable) + +### 步骤4 : 安装vuepress + +安装vuepress需要依赖v10.x以上的node.js,在命令行输入以下命令以查看node.js版本 +``` +nodejs -v +``` + +如果版本过低导致安装失败,输入以下命令安装新版的node.js,其中版本号14可以根据node.js官网的最新版本更改 + +``` +curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash - +sudo apt-get install -y nodejs +``` + +可以为所有项目安装全局的唯一 vuepress + +```bash +yarn global add vuepress +``` + +也可以在vuepress 项目根目录下安装每个项目各自的vuepress + +```bash +yarn add -D vuepress +``` + +### 步骤5 : 下载网站源码 + +```bash +git clone https://git.trustie.net/xuos/xuos-web.git +``` + +如果没有全局vuepress, 需要安装 + +```bash +cd xuos-web +yarn add -D vuepress +``` ## 工作阶段 -### 步骤3 : fetch +### 步骤6 : fetch 从 **upstream(xuos/xiuos)** fetch 代码到本地 @@ -43,7 +99,7 @@ git remote set-url --push upstream no_push git fetch upstream ``` -### 步骤4 : branch +### 步骤7 : branch 为本次工作创建一个分支,命名为 `develop` @@ -51,7 +107,7 @@ git fetch upstream git checkout -b develop upstream/master ``` -### 步骤5 : work, commit & commit +### 步骤8 : work, commit & commit 此时就可以在该分支下工作了, 不断修改代码,不断 commit @@ -61,17 +117,17 @@ git add . git commit -m "your commit message" ``` -### 步骤6 : push & push +### 步骤9 : push & push 如果经过测试,您觉得在本地完成了代码工作,您就可以将代码推送到您自己的服 务器端的仓库中了。 - +``` git push origin develop ``` push到自己的服务器端库中后,就可以准备创建`合并请求(Pull Request)`了。 -### 步骤7 : fetch +### 步骤10 : fetch 从XiUOS的主库, 即 upstream 中, fetch 最新的代码 @@ -79,7 +135,7 @@ push到自己的服务器端库中后,就可以准备创建`合并请求(Pull git fetch upstream ``` -### 步骤8 : merge +### 步骤11 : merge 将upstream 上最新的代码合并到你的当前工作分支 @@ -89,7 +145,7 @@ git merge upstream/master 此时请确保本地您位于工作分支。如果合并过程有冲突,您要负责解决冲突,并提交。 -### 步骤9 : push +### 步骤12 : push 将消解了冲突的最新本地代码,推送到个人服务器端仓库的develop分支。 @@ -97,7 +153,25 @@ git merge upstream/master git push origin develop ``` -### 步骤10 : 合并请求(pull request) +## 测试阶段 + +### 步骤13 : 终端测试 +```bash +yarn dev +``` + +会在终端启动 web server, 浏览器中访问 http://localhost:8080, 可观察网站效果 + +运行 +```bash +yarn build +``` + +可在 docs/.vuepress/dist 中生成编译后的html页面 + +## 合并阶段 + +### 步骤14 : 合并请求(pull request) 到自己个人服务器端仓库的首页 https://forgeplus.trustie.net/projects/panda/xiuos, 点击 **合并请求** , @@ -123,3 +197,5 @@ git checkout master git merge upstream/master git push origin master + +