From 9195ebef1cd95a802adb851e0904f18b57e61af1 Mon Sep 17 00:00:00 2001
From: Donggang Cao <caodg@pku.edu.cn>
Date: Sat, 1 May 2021 12:20:27 +0800
Subject: [PATCH] update webdoc, make steps accurate

---
 .gitignore                    |   2 +
 docs/community/.webdoc.md.swp | Bin 16384 -> 0 bytes
 docs/community/webdoc.md      |  87 ++++++++++++----------------------
 3 files changed, 33 insertions(+), 56 deletions(-)
 delete mode 100644 docs/community/.webdoc.md.swp

diff --git a/.gitignore b/.gitignore
index 595e215..b1eef1b 100755
--- a/.gitignore
+++ b/.gitignore
@@ -10,3 +10,5 @@ dist
 .basement
 config.local.js
 basement_dist
+*.swp
+*.lock
diff --git a/docs/community/.webdoc.md.swp b/docs/community/.webdoc.md.swp
deleted file mode 100644
index c6f3fe33d008b8c4fbcc1db541cbab4148bb3401..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 16384
zcmeI3du$xV9mf}1o-NRV)T$54VAD8>e0OmYAhD{JAfN>jl9or2QW~G{Hufd=;vONP
zKy4G-=g0XGJ5GWxiJjQ7N#Z*PCw`qD6{;##6_G$KwBiq5H@ka(6a=jbQc>0K%<S&%
znIzCZDz(yD`uMT4GxMA8?>DnEzdcv4dhGs9WSw)Bgs-njQfp0H)gLxpF5UN4Ns7jU
zk$C7yA1k`l*TxN79@)Ib@$emw-M?n-`VAMo^*N(K*Y0>I>Uc`7F8tyRd7>^)C=iGT
zeX%_*l;Mgq;Js*Lc7d&ct-u#oARgQ9Sa+SYW_1Oh>ZK*OlACUP^o!TG@3a-L6|fbs
z6|fbs6|fbs6|fbs75KkbAQrw{`ZY#zxjvFX{pV#%ett>+dx!q>*phPnPy2_hfUSV7
zfUSV7fUSV7fUSV7fUSV7fUSV7fUUs)paO2ZVZR=BrC9<1@BfYS|GPIx(mUW)&<Wh2
z3OvaEMuiTr4%`Vox=xZl1ZTknXaNZj1|hH$tOvJ)wcuuu!{-a$25*7a!JojZU=h@T
z$AJT^05^c^!ByZ&@UO2((iC_EYyq3WPr#4CkH9y;jo|CxH`k&~a10EBN^l1#2g^Yj
z*nf>A^@1+21yleBC<mWhElD4P55Vi-HSj8E0*&BVPz$`k1MUVJz<O{6xC}_(jjK=}
zoChz1G4LW71qZ<a@H}V$o54fi0dOZ+16G5Z!FNIKN=bSTyalGf1b7K_fF#%e?gBpm
zt3d_04qOAS2Jc@XNq+@0aD)57z2F{@`!d=F=fNvrALs^2@HE&3;-Cs_1Gj+hfo}r|
ze2PTTKS2UCgD8lAo4}3Wdhid#+DG6+@D6wz{1(iC36KFS9>>6vud1plX^%S+Bwl%!
zgg>g?(ORjrw3H}g!}*g#6>CT(QL_p4R7N@1re*d^C?w+7{J}{jeGZnRi5g#wgyYd#
z5{me0e7rT;9}4p_iH<iZlL>9)cy6|dHoc^ttXE&ytEB3bzHudWnx@8c+2iU!{ReaH
zO2=rvuAU~wbJHhtv$IMnNm~c$p;2_7%l6RO9#n*(tZABPQhGD*)ip4SOmkPmTxN$P
zDPu#*fk`bhr4FWZi-$!=O2cSwKAD^Cpi{%S`IOlPJ<*^XNztwZote}Yo7K@aCDkHK
zWmYweYA5Qovq!bF$1w`pG+`Fuex<W3H#@`)F_Z|%ks6uA!_inob_ZMmcQhtPOf8J-
zBsbkERKTc&1i}I~{`mo1r1L$rC26&_Xs{I+Ebpq|gY9z6Q)~7ty3A!e9``-E`C-<}
zbQU6(6PlbbZ-N<P<wR6mVop(StI!+23+oURhLKwHNjh}~&0770_R%2i>VR-`{0!}c
z=Z0x>6CG-%iGG@$t<q)AOetp?mT!ss{p4rzlW{p3TTz7oDH8HxAtn5!W;@|55sbQ<
zMq22?0h$^W?xyK>B?0d=>FRQ)i#rRZjq9am>@jy=Xk^?=EC?|^!_Y$Lt=A)uEYkzf
z2nO~UEX)o^fRyYB#Un)jJ0M4+?i#s7;&aFC^%AFWmk8W~eW_6`Gb|!CH{B+J0o|9w
zZ%L(ZEVr0edS}cTBrfWmSpByS_B|Df>?}77SZ3a2T3Rc6c821xwVEvlY?hf(QWV6w
zX-v)2%IQHPG?`y>({-4&!cgY>?s?jk#GRx{Z>!2`&Ydu)I^qs`FjbBIFA}_D<w|49
zEN7o{bM5xw`-+t-^`O<Ao6r{%YcF>cVis$Ju-3Y4@s*Eh@3@ETip${$oFaL=#P~QJ
zGmWo^l889vr9rkZG>+0Ub;kYWB%i9o`ashy+VRH1XgvN<P$sppSU6hga$$jV#v<`(
z%qKg8a*TgY&-}2S6QzZ&3Ndv%%!kjl`FVA|TRnA1neD<lDZ03z>8824nWOs5ON|<a
zlKkL|+MiYi*mpX=pG6b5S;=(5bE1@X?M3h-)Qwt}-fH}zYPX*-z06XxN6{UNjFviR
zq_@V~7kZ&h+M7X?6e_bZ<3o|&5OIfNjv6^ee8FhUjTOPMhXg}jc?Y}^kKoVfMpH?z
zT<v6KQA{R}?8J0(MdesLyscubb2oX0@b(<{66QDJ;9cn6Q(F=UTPzv5`3{<y)0)qU
z@zbF*+Sy^mthUfY8;7x8F=@KzbJ-zXpuTa`#Q<2p&K*$}-i?!321JXrbE;yk7(c{S
zl4<=mnm)+<W<2Y}%}W1S%vYhR7$R}-C$A*>GL#iTm0LKho$K3GvC6rdo7GxuL~2x+
zsSRGhc2rP~4y&m)-5k-sb$YBtd=>X9Nwje)hsRE5gEmsXRa-oiZ*G5Lxe>)4zdIWB
zd7Lcx!aHlY_;S$2KWnPH&Q%Hr`P@MV99iv`SBQ}sPR4rTb;o3~Y?<&A{BHW3HOky2
zCY-u=5)TnkTlUn3ND1041cATE2GOO9h(1Zc?F*I|p%9a0;=*Img}z)OXrfNPFB)@t
zU93y~yAfs&e@+kKc=b+skFzFRV>Hhq7nk^~;L#?`&!6a{jR~vRY$qkeCdNql(jSon
zAt-_vcJNSl@Q0qU;$a$W;~Sb%qMoQ%#*V3opN?VL)om`#L_E2~GH7j*O;ocT!-W@K
zh}eqCSD{j(r5Dusv{_M1pp_)wn8ao5_bV$U?5fzlY_U;GW2e%|ro(ts*d6q`mHtH~
zd5o<BmWQa?JE|n6@HAkR$y3nW7px)dOB*{uyIX~m*%tEBYbNhOtp3J|DM>2{_BUd?
zsJ=LxKX6tom{#T4rchkPrbX-wn8`Df#+dXc$ZQYxqVzBxW3!~>VtOqx0?%);)WPBT
z!E;4bw}-F|4Ey8JqLn`!3GI+Qv8c<^5?aAjQwF9W8+-EOnQ!bsiib9ar4<kV!hViF
zbBB^Nku?W_?VT|UOy{N~+YX)U)J786NMp@XT6*YQoza5T_^rm6KgV$K5Y|6&URWId
zlUggviP|tjo3pfY0^4A1WFHo`63PcsLX`HF{JykxU;n|}3!)Gss&A(07no3~(MQA+
z6?M%Rg9qNNOL1-Atvf7<c?fqKyI`>eW?NLD8g?z&dFy7@DmdGWvW)}Zz8V{cQUud1
z*AMf#o%Ze3AI^Qv%HVN{o&SG<Ga<nlm7V{0=m)Mrobw03A<zw)Km(`;_knxC?O-jq
z7F+|mkPBeBf#<-pU_D?tg4;kT_zTYce+F|P3r>NP;1itbKL+gVzW`>z2<QQOKsER!
z*aS8LmJ?VG{)Y4Y2jGw3ci?4k5cGn5;A!x4@F@5x*aUtE2)G%13rOHo<N)3QuYvPm
z7z}|r@C?`n?g9>Q6Ziyqfxm+{!5iQ_cm@0(90n=S4_ZMBxEpK$-vQqQ??daiz?)zk
zupGi3upLx`jo?A>04M{?!1uvzpcIsVTLJUgEx`V=6|fbs6|fbs75FbHp!Cfs6Z==Q
zeGRr}#*v(k9aMT3X#axR(u|J9FUnMwwho9~7Tb{Eh$J~(z5udE(TE4X)HuVz8h#mV
zMSM}uF8rS#b~xe)iJcMK-XMp>o5fxUDNt<XMYAk9D+=^>SpSW~N?&s>J4uITjBd~z
z?;)_$>x&TMsx?<4PJuWIx@z4KFLwE|3tL?eGAf~ni`Nxnt`K7uxlNIYC>}NjVdP&f
z*`{Tr^w<$55g(wT2j4zg3m~X^D2v30*ssA1w%<i=#vk&y{k5TJta9C|b*o%Rj^Z%S
zEiOupOX4&wYKyd+@_Zw0I>&Ei#}{k5@@}5oddMA+`H}3xDPdM=N!E)Wg9<4_PpvzM
zTyhNQQAk^2CJPJy*{K(?f9<S7WI#P3YO#i<Lvav7U?JwXhYOY2j+m>6+R8vPZEB?H
z8Q$V9U%=>}bz(`63HO+$@VmA7(+D@+ugH$`;Dy$_@QHGXkga8UuVv+BB6$m2uyrm&
zX<6Z4R?8~4@;X%*)U&8Yh~F37S!ub$WmsPu3;4_UEirj_tg^UO=~uiNrDXwjm8nAu
zw0*XWo&S(L;Yl1i)+Nl<X9VkzjoA|lZuiw7-SgQYJB=(2ZyGHb?P{GVn%u7pAfcwq
zS!_(cj%CJ}9G37jD~VFfP+fg?_8{zJGl68?LT;grcegas^w$gQ^2MXfW8`)%cQ1)N
zHg0YeOHmoGX6U|laUinh_|11Q>@daO!yu&iD-;~d_(4v*N#QB}67AS2Wnh{vK96H3
z?d;a-8kM$vYW8qB!I@VbNs39t+%Z?jGMwB)bRj{fr;&q#r;t%ZE(=KqB)5@hRqMxD
zV?$?@R6p84C+#h2<A}D{OZ$(YcV#aQyY*s%iUS(+c2iQks1dW9zh(H$1wHinh~NvQ
z?L|^0^nx;?Pz+r!G?OdFOO;AeqD=I&+0~Q8`z3WEt7ebV^pX6@cA6d%sS9@2=P4Fz
zZ<R<Rhz?PP<1LE;%PXpK!t(8X&A5yxK)@;oGf0c;iFIVc4KIk6p`y5eX3eARCEO@-
z7iQ|~a}M&ByoGU!hb`8(IxwhQ4<+#yktZ50F|j<%Ui(D!*FNl4BI+AwY%IV~k?_Q#
zIoVuZWbJVH9#ead;=PVK*QaH=ktBpFYz092C4cysNG7oi8>x=_{CrX5DLHMi3u#ik
zkmZkD@lKO=WoYXt!9T|%{}$OLM<BE%RidRA^9Rygm(M&VkY(x2Xd?|Yb5uY7?@!<z
GqV#WIR+XFp

diff --git a/docs/community/webdoc.md b/docs/community/webdoc.md
index 1adab2b..383af2b 100644
--- a/docs/community/webdoc.md
+++ b/docs/community/webdoc.md
@@ -1,24 +1,24 @@
 # 为XiUOS 完善网站文档
 
 ## 准备阶段
-首先，从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/xuos/xuos-web](https://forgeplus.trustie.net/projects/xuos/xuos-web), 点击右上角的"复刻" 按钮
 
-这样您就在自己的个人空间中有了XiUOS的一个复刻代码库, 地址为
+这样您就在自己的个人空间中有了XiUOS文档库的一个复刻代码库, 地址为
 
-项目首页为 "https://forgeplus.trustie.net/projects/panda/xiuos"
+项目首页为 "https://forgeplus.trustie.net/projects/panda/xuos-web"
 
-代码库地址为 "https://git.trustie.net/panda/xiuos.git"
+代码库地址为 "https://git.trustie.net/panda/xuos-web.git"
 
 ### 步骤2 : 下载到本地，并配置
 
 * 从个人空间下载
 
 ```
-git clone https://git.trustie.net/panda/xiuos.git
+git clone https://git.trustie.net/panda/xuos-web.git
 ```
 
 ::: warning     警告
@@ -29,7 +29,7 @@ git clone https://git.trustie.net/panda/xiuos.git
 
 ```
 # 设置 upstream
-git remote add upstream https://git.trustie.net/xuos/xiuos.git
+git remote add upstream https://git.trustie.net/xuos/xuos-web.git
 # 禁止直接向 upstream 推送代码
 git remote set-url --push upstream no_push
 ```
@@ -76,57 +76,38 @@ yarn global add vuepress
 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, 可观察网站效果
+yarn会编译文档, 并启动内置的web server. 在浏览器中访问 http://localhost:8080, 可观察网站效果
 
 运行
 ```bash
 yarn build
 ```
 
-可在 docs/.vuepress/dist 中生成编译后的html页面
+可在 docs/.vuepress/dist 中生成编译后的html页面, 可以单独启动一个web server观察效果，如 
 
-
-## 上传阶段
-
-### 步骤7 : fetch
-
-从 **upstream(xuos/xiuos)** fetch 代码到本地
-
-```
-git fetch upstream
+```bash
+python -m http.server
 ```
 
-### 步骤8 : branch
+
+## 工作阶段
+
+
+### 步骤5 : 创建工作分支
 
 为本次工作创建一个分支，命名为 `develop`
 
 ```
-git checkout -b develop upstream/master
+git checkout -b develop
 ```
 
-### 步骤9 : work, commit & commit
+### 步骤6 : work, commit & commit
 
 此时就可以在该分支下工作了, 不断修改代码，不断 commit
 
@@ -136,36 +117,29 @@ git add .
 git commit -m "your commit message"
 ```
 
-### 步骤10 : push & push
+### 步骤7 : push & push
 
 如果经过测试，您觉得在本地完成了代码工作，您就可以将代码推送到您自己的服务器端的仓库中了。
 ```
 git push origin develop
 ```
 
-push到自己的服务器端库中后，就可以准备创建`合并请求(Pull Request)`了。
+push到自己的服务器端库中后，就可以考虑创建`合并请求(Pull Request)`了, 为
+此需要将本地库和upstream同步。
 
-### 步骤11 : fetch
+### 步骤8 : 和upstream 同步
 
-从XiUOS的主库, 即 upstream 中, fetch 最新的代码
 
 ```
 git fetch upstream
-```
 
-### 步骤12 : merge
-
-将upstream 上最新的代码合并到你的当前工作分支
-
-```
 git merge upstream/master
 ```
 
-此时请确保本地您位于工作分支。如果合并过程有冲突，您要负责解决冲突，并提交。
+请确保本地您位于工作分支。如果合并过程有冲突，您要负责解决冲突，并提交。
 
-### 步骤13 : push
 
-将消解了冲突的最新本地代码，推送到个人服务器端仓库的develop分支。
+然后将消解了冲突的最新本地代码，推送到个人服务器端仓库的develop分支。
 
 ```
 git push origin develop
@@ -173,9 +147,9 @@ git push origin develop
 
 ## 合并阶段
 
-### 步骤14 : 合并请求(pull request)
+### 步骤9 : 合并请求(pull request)
 
-到自己个人服务器端仓库的首页 https://forgeplus.trustie.net/projects/panda/xiuos, 点击 **合并请求** ,
+到自己个人服务器端仓库的首页 https://forgeplus.trustie.net/projects/panda/xuos-web, 点击 **合并请求** ,
 
 设置源分支:
 
@@ -183,7 +157,7 @@ git push origin develop
 
 设置目标分支:
 
-目标仓库选择 upstream 库, 即: "泛在操作系统实验室/xiuos"
+目标仓库选择 upstream 库, 即: "泛在操作系统实验室/xuos-web"
 
 目标分支选择 `master`
 
@@ -256,8 +230,9 @@ mkdir imagesrc
 ```
 将图片img.png放入文件夹imagesrc中
 在riscv.md中需要用到该图片的位置添加
-```
-./imagesrc/img.png
+
+```md
+![Image description](./imagesrc/img.png)
 ```
 图片添加完成。