修改README.md中git clone为 https://github.com/xuos/xuos-web

it is OK
This commit is contained in:
xuedongliang 2021-04-30 15:50:14 +08:00
commit 877e2693fe
5 changed files with 8282 additions and 3 deletions

View File

@ -57,7 +57,7 @@ yarn add -D vuepress
### 下载网站源码
```bash
git clone https://github.com/xuos/xuos-web
git clone https://git.trustie.net/xuos/xuos-web.git
```
如果没有全局vuepress, 需要安装

Binary file not shown.

View File

@ -1,3 +1,272 @@
# 为XiUOS 完善网站文档
## 准备阶段
首先从XiUOS主库中复刻一份到自己的个人空间。
假定您在Trustie的用户名为“panda”
### 步骤1复刻
再在浏览器中打开XiUOS的项目首页[https://forgeplus.trustie.net/projects/xuos/xuos-web](https://forgeplus.trustie.net/projects/xuos/xuos-web), 点击右上角的"复刻" 按钮
这样您就在自己的个人空间中有了XiUOS的一个复刻代码库, 地址为
项目首页为 "https://forgeplus.trustie.net/projects/panda/xiuos"
代码库地址为 "https://git.trustie.net/panda/xiuos.git"
### 步骤2 : 下载到本地,并配置
* 从个人空间下载
```
git clone https://git.trustie.net/panda/xiuos.git
```
::: warning 警告
请务必记住将panda替换为您自己的用户名
:::
* 配置
```
# 设置 upstream
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
```
## 修改测试
### 步骤6 : 修改测试
修改你想要修改的内容,修改完之后启动测试
```bash
yarn dev
```
会在终端启动 web server, 浏览器中访问 http://localhost:8080, 可观察网站效果
运行
```bash
yarn build
```
可在 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)
到自己个人服务器端仓库的首页 https://forgeplus.trustie.net/projects/panda/xiuos, 点击 **合并请求** ,
设置源分支:
选择 设定的工作分支, 本文的例子是 **develop** 分支
设置目标分支:
目标仓库选择 upstream 库, 即: "泛在操作系统实验室/xiuos"
目标分支选择 `master`
提交即可。
如果您的"合并请求"被核心开发者拒绝, 这种情况在开源社区很常见,所以请不要灰心失望, 请按照返回的意见修改完善,再提交即可。
### 更新本地和个人服务器端仓库的主分支
```
git fetch upstream
git checkout master
git merge upstream/master
git push origin master
```
## 用法举例
### 增加菜单栏选项的内容
在'社区'菜单栏中增加'测试文档'选项:
```
cd xuos-web/docs/.vuepress
vim config.js
```
找到'社区',在其中子目录添加
```
{
text:'测试文档',
link:'/community/testdoc.html'
}
```
找到'/community',在其子目录添加
```
[
['testdoc','测试文档'],
],
```
转到目录创建testdoc.md文件
```
cd xuos-web/docs/community
vim 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
```
最终合并到目标仓库中完成修改
### 增加图片
在xuos-web/docs/doc/hardware/processor/riscv.md中增加图片img.png
方法1在当前目录存放图片
```
cd xuos-web/docs/doc/hardware/processor/
mkdir imagesrc
```
将图片img.png放入文件夹imagesrc中
在riscv.md中需要用到该图片的位置添加
```
./imagesrc/img.png
```
图片添加完成。
方法2在根目录存放图片

View File

@ -14,9 +14,9 @@
},
"license": "MulanPSL-2.0",
"devDependencies": {
"vuepress": "^1.3.1",
"@vuepress/plugin-back-to-top": "^1.3.1",
"@vuepress/plugin-medium-zoom": "^1.3.1"
"@vuepress/plugin-medium-zoom": "^1.3.1",
"vuepress": "^1.8.2"
},
"dependencies": {
"element-ui": "^2.13.2"

8010
yarn.lock Normal file

File diff suppressed because it is too large Load Diff