1
0
mirror of https://github.com/ZSCNetSupportDept/website.git synced 2025-10-29 09:25:04 +08:00

准备新的开发组文档,初步手机端访问支持

原来的在docs/devdocs/_legacy目录下面
This commit is contained in:
2025-06-13 23:02:06 +08:00
parent c80789134c
commit 266a2976bb
60 changed files with 46 additions and 31 deletions

View File

@@ -0,0 +1,22 @@
# 开发组网站-概览
## 技术
网站基于Docusaurus开发,一个静态网页生成的框架尤其对于生成技术文档来说它提供了一个美观现代的前端界面这个项目本身是一个react.js应用生成网页时只要输入`npm run build`便可以在build目录里构建网站的所有资源以进一步部署关于详细的配置可以去看官方的文档[文档连接](https://www.docusaurus.cn/docs/category/guides)
## 工作流程
基本上我们需要把markdown文件放在目录里面系统就会根据目录的结构自动生成网页但是我们必须写好配置文件如果我们想自定义网站的外观的话也需要好好研究一下配置文件有关文档还在编写中 \
开发组网站的开发流程基本如下:
1. 将源代码仓库的最新版本拉取到本地对仓库的内容进行修改最终在本地的master分支上commit,
2. 运行`npm start``https://localhost:3000`上运行基于改动构建的预览版本
3. 测试改动确保一切正常后push到github上
4. demo网站会自动根据github上的msater分支构建网页构成开发组网站的预览版本
5. 积累几个改动后,在本地运行`npm run deploy`将网页构建好推送给github上的`build`分支,网站服务器自动获取并更新,构成开发组网站的正式版本
## 目录
所有的文档文件都储存在docs文件夹下\
所有的公告文件都储存在blog文件夹下\
所有的静态页面都储存在src/pages文件夹下\
所有的媒体文件都储存在static文件夹下供用户下载的资源也储存在这里\
docusaurus.config.js是项目的配置文件配置格式请参照官方文档
## 部署
目前不确定
## 注意事项
最好还是看官方文档

View File

@@ -0,0 +1,43 @@
# 开发组网站-内容
**本篇文章将教你进行内容发布,维护开发组网站内容的方法**
## 如何修改
### Edit This Page
页面最下面有一个Edit This Page的超链接点击就可以进入github里这个页面的源代码可以提交PR有权限的也可以直接修改
### git clone
(该方法仅限有权限的开发组成员)\
如果你要进行比较多的修改的话,你也可以将仓库拉取到本地,然后修改,新建文件夹,打开终端
- 输入`git clone https://github.com/ZSCNetSupportDept/website.git`
- 输入`git checkout master`
- 此时你应该可以看见项目的源代码,修改你需要改动的内容,然后输入`git add *`
- 输入`git commit`,将你的改动提交到本地
- 输入`git push`,提交内容到仓库
## 仓库的内容
你可以看见三个文件夹分别是src,docs,blog,其中:
- src文件夹存放了独立于文档和blog的静态页面
- docs文件夹存放了所有的文档目前有wiki和开发组文档两个docs
- blog文件夹存放了可以显示在“公告”板块的文章
所有的文档都以Markdown格式书写其实也可以用MDX格式
### 前缀
所有文件都有一个数字前缀,这是文章在成品网站中的顺序,文件请按照`order-filename.md`的格式命名
btw,docusaurus不会将以"_"开头的文件加入完成的网页中,所以可以在暂时不想要展现在最终网站的里的的文章前面加上一个下划线
### 栏目的概况
我们可以在一个子文件夹中加入`index.md`或者`README.md`或者`{$文件夹的名称}.md`,其中的内容会在成品网站中显示为这个栏目的概况(点击这个栏目本身出现的内容)
### Markdown 文档
Markdown 是一个标记文本格式的语言轻便简单快捷markdown最基本的语法如下[markdown语法](https://commonmark.org/) 我们用Markdown来编写文档,需要注意的是文档只能有一个h1系统用它来产生sidebar条目
另外docusaurus好像支持mdx格式的文档可以把一些动态元素插入到文本中
### 媒体资源引用
请将所有媒体资源放在static目录内然后在文档中调用
### 下载
`static`目录下面的内容会直接放到生成的网页里我们在wiki和开发组文档里各设置了一个下载页面提供便捷访问的方式在Markdown文本里链接这些文件来提供下载的方式
### 公告
docusaurus自带一个blog插件需要按照`yyyy-mm-dd-filename.md`的格式发布
## 文档的维护
如果发现了文档有错误的地方请提交PR修改或者告知开发组成员
## 进阶
更详细的内容还是建议看docusaurus的官方文档[文档连接](https://www.docusaurus.cn/docs/category/guides)

View File

@@ -0,0 +1,15 @@
# 开发组网站-部署
本篇文章是开发组网站的部署流程备忘录
## 开发部署流程
网站假设在我们的云服务器上服务器会自动从仓库的build分支拉取内容所以网站的开发部署流程是这样的
1. 将website仓库clone到本地/pull拉取最新版本
2. 运行`npm start`在localhost:3000上运行网站的测试版本
3. 确认网站的最新版本没有问题后,运行`npm run docusaurus deploy`npm会自动构建网页文件推送到origin/build分支上(记得配置好你的ssh,联系组长来获取仓库的权限)
4. 服务器获取build分支的最新版本pull到`/var/www/developer`目录下
5. 服务器采用nginx提供对developer.zsxyww.com的访问
## demo
我在cloudflare pages上部署了一个网站的demo,这个网站会自动基于master分支构建而不是获取构建好的build分支可以在上面预览网站的效果觉得没问题了再进行build,网址https://zscdev-demo.pages.dev/
## 服务端
目前网站服务器拉取build构建的方式是通过定时执行5分钟1次一个特定的更新脚本位置在`/opt/developer-build.sh`写在crontab里了

View File

@@ -0,0 +1,9 @@
# 开发组网站-外观
**本篇指南将教你如何修改开发组网站的外观**
看官方文档

View File

@@ -0,0 +1,249 @@
# 快速上手
修网的知识需要在实践中不断积累网维的wiki做为每一个网维成员经验的总结自然也需要不断的更新但是wiki本身大部分时间都是由开发组的仅仅几个人来维护难以时刻更新到最新情况所以我们想让网维的每个人都能加入wiki的维护这篇文章就是写给希望为wiki添砖加瓦却不太了解相关方法的小伙伴的希望这篇文章能够快速让你上手wiki的维护工作。
在这篇文章里我们将教你:\
将我们在github上的主仓库fork一份然后将fork仓库clone到你的电脑;修改网站源代码;将你的修改传回fork仓库提交pull request
:::info 信息
在正式开始编辑前,你可以看看我们的成品网站,每篇文章的下面会有一个`Edit This Page`的链接,是这篇文章的源代码,这里是网站的链接:[Click Me ](https://zscdev-demo.pages.dev/)
:::
## 准备
我们假设你所使用的是windows系统。
首先我们需要安装必要的开发工具git 和 Node.js。
访问如下链接:[git下载](https://git-scm.com/download/win) , [Node.js下载](https://nodejs.org/zh-cn/download/prebuilt-installer)。
:::info 信息
你也可以通过windows自带的WinGet包管理器下载,详见:[微软文档](https://learn.microsoft.com/zh-cn/windows/package-manager/winget/)。
:::
:::tip git是什么
git是一个版本控制工具他会记录一个项目从创建之初任何人对任何文件的任何改动大大方便了多人协作工程的管理wiki的源代码托管在基于git设计的github上。
:::
:::tip Node.js是什么?
Node.js是一个在后端运行javascript的运行时我们使用基于这个平台设计的docusaurus框架来将wiki从一堆markdown文档变成一个网站。
:::
访问github,如果没有账号就注册一个然后打开https://github.com/ZSCNetSupportDept/website。
点击上面的fork,创建仓库的一个分支点击create fork。
进入你刚才fork的仓库点击Code,选择HTTPS,复制下面的那一串内容。
然后,请打开你的终端,你可以在“开始”菜单栏里搜索"PowerShell"来打开。
如果你的系统没有安装PowerShell,你可以使用cmd`Win+R`,在弹出框里输入`cmd`打开。
输入`git clone 你复制的内容`,这将在你的当前目录下创建一个名为`website`的文件夹,并将开发组网站的全部内容复制到这个文件夹里面。
:::tip 提示
你可能会需要科学上网的手段来访问github。
:::
然后,输入`cd website`
切换到我们的项目目录下后,运行`npm install`来安装项目的所有依赖。
:::tip 提示
为了加速下载你可能会需要配置npm镜像可以输入`npm config set registry https://registry.npmmirror.com`
:::
现在,输入`npm start`,程序就会在你的电脑上构建并部署网站。
然后在你的浏览器上输入`https://localhost:3000`
如果没有出错的话,你会看到我们开发组网站的主页。
:::tip 提示
每次启动测试版网站,都需要在这里再输入一次`npm start`
:::
## 编辑
打开`website`下的`docs`文件夹,再打开`wiki`文件夹,这里就是我们的wiki内容仓库了。
仓库里的所有的文章都是以md结尾的markdown文件你需要熟悉markdown的写法才能对文章的内容修改和完善markdown并不是特别复杂你可以花一点时间去学会他。
:::info 信息
这里是一些学习markdown的资源https://markdown.com.cn/ \
https://github.highlight.ink/mastering-markdown/intro \
https://commonmark.org/ (英文)
:::
如果想要在文本中添加图片视频或者其他资源请将这些素材放入static中以方便管理。
对代码的修改将会自动同步到刚才打开的网页里,你可以在那里确认修改的结果满意与否,注意,你需要保存文件才会同步更改。
修改完毕后,输入`git add .`再输入`git commit`,并对你的修改做出一个简短的说明。
### 改什么?
你可以校对已有的条目,增加一些内容,或者加入一些图片之类的。
你也可以添加新条目,撰写一些你觉得有价值的修网心得。
或是帮助我们改善网站本身比如改一改主题写一个首页等如果有相关能力需要react基础
### 文件名
你会发现所有文件的名字前面都有一个数字那就是文章在sidebar中出现的顺序增添文件请按照`order-filename.md`的格式修改名字。
在文件名前加一个下划线,系统就不会将文章加入成品网站中。
:::tip 提示
关于如何修改wiki的更多提示,可以去看docusaurus的官方文档[链接](https://docusaurus.cn)
:::
## 推送到仓库
在修改完毕并且在本地检查完毕后你需要将你的修改同步到你在github的远程fork仓库然后再提交一个pull request请求主仓库合并你在fork仓库所做的修改。
首先你需要验证你的身份让github允许你的电脑向它提交push
:::tip 提示
你可以使用github desktop或github cli来简化这个流程不过我们想让你在这个过程中学习SSH的用法如果你想方便一点直接跳到“使用github-cli”。
:::
### 选项1:使用SSH
首先确保你安装了SSH,你可以看微软的这片文档:[链接](https://learn.microsoft.com/zh-cn/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui)。
打开终端,输入
```PowerShell
ssh-keygen -t ed25519
```
然后在接下来的选项中检查密钥的存放路径,以及使用一个密码来加密这个密钥,我们建议你设置一个密码。
然后我们设置开机自动启动ssh-agent服务。
确保你使用了管理员权限运行了下面的PowerShell代码
```PowerShell
Get-Service ssh-agent | Set-Service -StartupType Automatic
Start-Service ssh-agent
Get-Service ssh-agent
```
最后一个命令应该会返回`Running`状态。
然后,你就可以输入`ssh-add`来加载你的密钥。
```PowerShell
ssh-add 你的私钥位置
```
:::tip 提示
每次重启电脑,你都要重新输入一遍`ssh-add`
:::
:::info 信息
关于SSH的配置参考了这片[微软文档](https://learn.microsoft.com/zh-cn/windows-server/administration/openssh/openssh_keymanagement)。
:::
接下来我们配置github的SSH访问。
打开与私钥同目录下的公钥文件(以pub结尾),然后复制他,注意要全部复制,不要多出或减少任何内容。
点一下你的github头像选择Settings,然后在侧边栏的Access板块找到SSH and GPG keys。
点击 `New SSH key`
把密钥粘贴到下面,然后保存就行了。
在终端里输入
```PowerShell
ssh git@github.com
```
如果返回的文本里出现了你的用户名,配置就大概成功了。
现在就可以输入`git push`
```PowerShell
git push
```
这个命令会向远端的仓库提交你在本地提交的commit,检查你的fork仓库有没有更新到你本地的修改
:::info 信息
参考了github的文档:[Click Me ](https://docs.github.com/zh/authentication/connecting-to-github-with-ssh/about-ssh)
:::
### 选项2使用github-cli
访问https://github.com/cli/cli/releases 下载最新版本。
输入`gh`以检查安装的成功状况。
没问题的话,输入`gh auth login`,会弹出一个浏览器窗口,在弹出的窗口中完成登录。
然后,你应该就可以直接使用`git push`了,输入`git push`,然后查看你在github中的fork仓库有没有更新到你本地的修改。
:::info 信息
这里有更多关于github cli 的信息:[Click Me ](https://docs.github.com/zh/github-cli/github-cli/about-github-cli)
:::
### 提交pull request
一个pull request 是一个请求,将修改建议发送给主仓库,并让主仓库合并这些修改。
打开主仓库选择上面的Pull Requests,然后选择New Pull Request,如果没有出现你的fork仓库点击compare accross forks。
然后就可以Create Pull Request了。
提交后,开发组成员会校对你的修改,将你的修改应用到主仓库中,这就是我们的开发流程了。
:::info wiki的分层更新模型
按照我们的设计wiki的内容从新到旧一共分为三个版本
- 最新的版本是大家在自己的电脑上运行的测试版网站,这个版本包含了最新的想法和更改,等待完善后推送到主仓库。
- 然后是我们的demo版本网站[zscdev-demo.pages.dev](zscdev-demo.pages.dev),这个版本立即反应了任何被合并进去主仓库master分支的更改大家可以对这个网站上的内容随便提意见任何修改都将很快被同步到网站里。
- 当主仓库和demo网站的更新积累到一定程度的数量时开发组成员会根据一个版本作为wiki的正式版正式推送到我们的网站[developer.zsxyww.com](developer.zsxyww.com)里这个版本通常要比demo要落后几次更新但是那些在施工中的文章和还在讨论的段落等不稳定的内容将不会被同步到这里换句话说这个版本是“稳定版”。
这样网站的测试和正式使用的版本就分开了,保证了网站内容的严谨
:::