mirror of
https://github.com/ZSCNetSupportDept/website.git
synced 2025-10-28 17:05:03 +08:00
初始化仓库
This commit is contained in:
22
docs/devdocs/01-首页.md
Normal file
22
docs/devdocs/01-首页.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# 开发组首页
|
||||
**欢迎来到中山学院网络维护科开发组!**\
|
||||
**开发组是一个相对独立的小组,负责维护网维日常所用的系统,**\
|
||||
**这里是开发组所维护系统的文档**
|
||||
## 项目清单
|
||||
我们手头上的项目
|
||||
### 网站
|
||||
zsxyww.com,网维的官网
|
||||
### 网维报修系统
|
||||
负责受理用户的故障保修,允许网维成员跟踪问题的解决情况,并管理工单\
|
||||
目前所使用的是上一届开发组成员所开发的系统,目前我们不熟悉其架构和细节,计划开发新的报修系统
|
||||
### 招新系统
|
||||
招新的系统
|
||||
### 基础设施
|
||||
开发组所持有的基础设施,包括云服务器,域名等
|
||||
## 你应该知道......
|
||||
### 项目托管
|
||||
我们的项目托管在github上,私聊组长来获得进入organization的权限
|
||||
### 文档编写
|
||||
为了项目的持续维护,对于我们的每一个项目都应该留有详尽的文档,文档以markdown格式编写,可以自动构建成静态网页,详见**网站/如何修改开发组网站内容**
|
||||
|
||||
|
||||
7
docs/devdocs/02-网站/01-子站点.md
Normal file
7
docs/devdocs/02-网站/01-子站点.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# 子站点
|
||||
## www.zsxyww.com
|
||||
www.zsxyww.com是网维的官网
|
||||
## wiki.zsxyww.com
|
||||
wiki.zsxyww.com是网维的旧版wiki
|
||||
## developer.zsxyww.com
|
||||
developer.zsxyww.com是网维开发组的站点,托管了新版wiki和网维各种系统的文档
|
||||
17
docs/devdocs/02-网站/02-开发组网站概览.md
Normal file
17
docs/devdocs/02-网站/02-开发组网站概览.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# 开发组网站概览
|
||||
## 技术
|
||||
网站基于Docusaurus开发,一个静态网页生成的框架,尤其对于生成技术文档来说,它提供了一个美观,现代的前端界面,这个项目本身是一个react.js应用,生成网页时只要输入:`npm run build`便可以在build目录里构建网站的所有资源,以进一步部署,关于详细的配置,可以去看官方的文档:[文档连接](https://www.docusaurus.cn/docs/category/guides)
|
||||
## 工作流程
|
||||
基本上,我们需要把markdown文件放在目录里面,系统就会根据目录的结构自动生成网页,但是我们必须写好配置文件,如果我们想自定义网站的外观的话,也需要好好研究一下配置文件,有关文档还在编写中
|
||||
## 目录
|
||||
所有的文档文件都储存在docs文件夹下\
|
||||
所有的公告文件都储存在blog文件夹下\
|
||||
所有的静态页面都储存在src/pages文件夹下\
|
||||
所有的媒体文件都储存在static文件夹下\
|
||||
系统会根据这些文件,在build里生成网站的所有页面文件,以供我们部署
|
||||
|
||||
docusaurus.config.js是项目的配置文件,配置格式请参照官方文档
|
||||
## 部署
|
||||
目前不确定
|
||||
## 注意事项
|
||||
最好还是看官方文档
|
||||
22
docs/devdocs/02-网站/03-如何修改开发组网站内容.md
Normal file
22
docs/devdocs/02-网站/03-如何修改开发组网站内容.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# 开发组网站-内容发布
|
||||
**本篇文章将教你如何为开发组网站贡献内容,修改内容,以及内容的维护**
|
||||
## Edit This Page
|
||||
页面最下面有一个Edit This Page的超链接,点击就可以进入github里这个页面的源代码,可以提交PR,有权限的也可以直接修改
|
||||
## 增加内容
|
||||
docusaurus按照一定的文件层次将markdown文档转换成静态页面,在仓库里,docs文件夹下的是网站的文档,blog文件夹下的为公告,src/pages下的为独立页面(如首页),如果要增添新的内容,记得把内容放在正确的地方里
|
||||
### 前缀
|
||||
所有文件都要加入一个数字前缀,用来指示构建系统按照序号生成文章在sidebar中的顺序,按照`order-filename.md`的格式命名
|
||||
|
||||
btw,docusaurus不会将以"_"开头的文件加入完成的网页中,所以可以在暂时不想要展现在最终网站的里的的文章前面加上一个下划线
|
||||
### Markdown 文档
|
||||
Markdown 是一个标记文本格式的语言,轻便简单快捷,markdown最基本的语法如下:[markdown语法](https://commonmark.org/) ,我们用Markdown来编写文档,需要注意的是,文档只能有一个h1,系统用它来产生sidebar条目
|
||||
|
||||
另外docusaurus好像支持mdx格式的文档,可以把一些动态元素插入到文本中,
|
||||
### 媒体资源引用
|
||||
将所有媒体资源放在static目录内,然后在文档中调用
|
||||
|
||||
## 公告
|
||||
docusaurus自带一个blog插件,需要按照`yyyy-mm-dd-filename.md`的格式发布
|
||||
|
||||
## 文档的维护
|
||||
如果发现了文档有错误的地方,请提交PR修改,或者告知开发组成员,
|
||||
2
docs/devdocs/02-网站/04-网站外观修改.md
Normal file
2
docs/devdocs/02-网站/04-网站外观修改.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 网站外观修改
|
||||
**本篇指南将教你如何修改开发组网站的外观**
|
||||
1
docs/devdocs/02-网站/05-旧版wiki.md
Normal file
1
docs/devdocs/02-网站/05-旧版wiki.md
Normal file
@@ -0,0 +1 @@
|
||||
# 旧版wiki
|
||||
11
docs/devdocs/02-网站/index.md
Normal file
11
docs/devdocs/02-网站/index.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# 网站
|
||||
## 概述
|
||||
目前,网站有www.zsxyww.com(主站点),wiki.zsxyww.com(旧wiki),和developer.zsxyww.com(开发组网站),这些子域
|
||||
### www.zsxyww.com
|
||||
好像是前辈们留下来的项目,暂时不清楚情况
|
||||
### wiki.zsxyww.com
|
||||
旧版的wiki,使用wiki.js构建,上面存放了累积下来的许多文章,目前准备迁移
|
||||
### developer.zsxyww.com
|
||||
目前集中开发的新站点,把计划发布的新版wiki和开发组的文档都放在上面了,使用docusaurus构建
|
||||
## 部署
|
||||
网站部署在腾讯云的服务器上,dnspod进行解析,nginx反向代理,官网和旧wiki是封装在docker容器里的,监听8090端口和3000端口,
|
||||
1
docs/devdocs/03-网维报修系统/index.md
Normal file
1
docs/devdocs/03-网维报修系统/index.md
Normal file
@@ -0,0 +1 @@
|
||||
# 网维报修系统
|
||||
2
docs/devdocs/03-网维报修系统/概览.md
Normal file
2
docs/devdocs/03-网维报修系统/概览.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 网维报修系统
|
||||
目前所使用的系统在这里:[系统](https://github.com/ZSCNetSupportDept/WechatTicketSystem) 暂时不了解,难以维护,准备开发新的报修系统
|
||||
1
docs/devdocs/04-招新系统/README.md
Normal file
1
docs/devdocs/04-招新系统/README.md
Normal file
@@ -0,0 +1 @@
|
||||
# 招新系统
|
||||
2
docs/devdocs/04-招新系统/概览.md
Normal file
2
docs/devdocs/04-招新系统/概览.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 招新系统
|
||||
不了解
|
||||
5
docs/devdocs/05-基础设施/README.md
Normal file
5
docs/devdocs/05-基础设施/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 基础设施
|
||||
## 服务器
|
||||
我们目前拥有负责报修系统和网站的两台服务器,位于tx云上,联系组长以获得访问权限
|
||||
## 域名
|
||||
我们拥有一个域名zsxyww.com
|
||||
2
docs/devdocs/05-基础设施/zsxyww.com域名.md
Normal file
2
docs/devdocs/05-基础设施/zsxyww.com域名.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# zsxyww.com
|
||||
这个域名目前托管在west.cn上,腾讯云dns,关于域名的交接事项,请联系组长
|
||||
2
docs/devdocs/05-基础设施/报修服务器.md
Normal file
2
docs/devdocs/05-基础设施/报修服务器.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# 报修服务器
|
||||
|
||||
13
docs/devdocs/05-基础设施/网站服务器.md
Normal file
13
docs/devdocs/05-基础设施/网站服务器.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# 网站服务器
|
||||
## 概况
|
||||
ip:**43.129.159.235**
|
||||
|
||||
OS:**Debian 10.2 64bit**
|
||||
|
||||
配置:CPU - 1核 内存 - 1GB\
|
||||
系统盘 - SSD云硬盘 25GB\
|
||||
流量包 - 1024GB/月(峰值带宽:30Mbps)
|
||||
|
||||
服务:官网(通过docker部署,8090端口,nginx反代)\
|
||||
旧版wiki(docker,3000端口,nginx反代)\
|
||||
新网站(TODO:补充部署方式)
|
||||
6
docs/devdocs/06-联系开发组.md
Normal file
6
docs/devdocs/06-联系开发组.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# 加入开发组
|
||||
可以参照下面的联系方式和开发组进行联系
|
||||
## 联系方式
|
||||
QQ群:961797864
|
||||
QQ:2597760847(组长)
|
||||
|
||||
Reference in New Issue
Block a user