docs: 合并上游更改

2025-04-29 13:46:41 +00:00 · 2025-02-06 19:40:41 +08:00 · 2025-02-06 19:40:41 +08:00 · 4d67e56fe6
commit 4d67e56fe6
parent 0e5218d456
7 changed files with 194 additions and 28 deletions
--- a/README.md
+++ b/README.md
@ -4,7 +4,7 @@

 ## 开始之前

-不要刷测速了！Vercel 有 ddos 防火墙了！越刷越慢！
+不要刷测速了！Vercel 有 DDoS 防火墙了！越刷越慢！
 （也不要尝试攻击了，Vercel 也有攻击验证模式了）

 ![ksnip_20250202-003641](https://github.com/user-attachments/assets/0b49e8fa-80fb-46aa-adc0-c234be4e06bc)
@ -14,7 +14,7 @@
 ## 开始编写文档

 1. 安装 Node 20 环境（推荐使用NVM）
-2. 克隆并进入文档仓库
+2. 克隆并进入文档仓库目录
 3. 安装依赖（需要使用pnpm，可使用corepack安装）
   ```sh
   pnpm install
@ -26,7 +26,7 @@
    pnpm run docs:dev
    ```

-5. 在浏览器中键入终端输出的链接（默认是[http://localhost:8080](http://localhost:8080)），即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。
+5. 在浏览器中访问终端输出的链接（默认是[http://localhost:8080](http://localhost:8080)），即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。

 本文档使用了 vuepress-plugin-md-enhance
 的一些扩展语法，请尽量直接编辑 Markdown 文件，而不是使用可视化 Markdown 编辑器。建议使用 [Visual Studio Code](https://code.visualstudio.com/) 编辑文档。
@ -36,7 +36,7 @@

 ## 做出贡献

-我们欢迎向本仓库提交 [Pull Request](https://github.com/ExamAware/ExamAware-docs/pulls)。
+欢迎向本仓库提交 [Pull Request](https://github.com/ExamAware/ExamAware-docs/pulls)。

 ## 许可证

--- a/src/README.md
+++ b/src/README.md
@ -48,12 +48,22 @@ ExamAware 系列可以显示当前时间与考试详细信息，并支持在各
 <div class="vp-card-container">
  <VPCard
    title="桌面端应用帮助"
-    desc="了解桌面端应用的基本使用方法。"
+    desc="了解桌面端应用的使用方法。"
    link="./app/"
  />
  <VPCard
-    title="集控和网页版应用帮助"
-    desc="了解集控帮助以及网页版应用部署的教程。"
+    title="网页端应用帮助"
+    desc="了解网页端应用使用方法和部署教程。"
+    link="./web/"
+  />
+  <VPCard
+    title="集控帮助"
+    desc="了解集控使用方法和部署教程。"
    link="./management/"
  />
+  <VPCard
+    title="社区"
+    desc="了解如何参与 ExamAware 社区。"
+    link="./community/"
+  />
 </div>
--- a/src/app/profile/faq.md
+++ b/src/app/profile/faq.md
@ -1,10 +1,12 @@
 # 编写配置文件

-本应用配置文件记录了考试名称、提示信息、考场号，考试信息（科目名称、开始/结束时间、结束提醒时间）。
+本应用配置文件记录了考试名称、提示信息，考试信息（科目名称、开始/结束时间、结束提醒时间）。

-您可以按照模板手动编写配置文件，也可以直接使用[配置文件编辑器（旧版）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest)编写配置文件。
+您可以按照模板手动编写配置文件，也可以直接使用[配置文件编辑器（legacy）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest)编写配置文件。

-在新版本（即 [`ExamAware2`](https://github.com/ExamAware/ExamAware2) 和 [`ExamCloudSchedule`](https://github.com/ExamAware/ExamCloudSchedule) ）中，已经集成了编辑器，可以略过本部分帮助。
+> [!tip]
+>
+> 在新版本（即 [`ExamAware2`](https://github.com/ExamAware/ExamAware2) 和 [`ExamCloudSchedule`](https://github.com/ExamAware/ExamCloudSchedule) ）中，已经集成了编辑器，可以略过本部分帮助。

 ## 手动编写配置文件   
 > [!warning]
@ -19,17 +21,18 @@
 {
  "examName": "考试名称",
  "message": "提示信息",
-  "room": "考场号",
  "examInfos": [
    {
      "name": "科目",
      "start": "2025-01-01T07:00:00",
-      "end": "2025-01-01T08:00:00"
+      "end": "2025-01-01T08:00:00",
+      "alertTime": 15
    },
    {
      "name": "科目/科目",
      "start": "2025-01-01T09:00:00",
-      "end": "2025-01-01T10:00:00"
+      "end": "2025-01-01T10:00:00",
+      "alertTime": 15
    }
  ]
 }
@ -39,22 +42,27 @@
 >
 > 考试名称不能为空，`examInfos` 至少需要一条数据（科目名称不能为空，开始时间和结束时间不能为空，且前者必须早于后者，考试结束提醒时间必须是非负整数）。
 >
-> 如果有两个以"/"分隔的科目可以自动转化为双行显示
+> 如果有两个以"/"分隔的科目可以自动转化为双行显示（旧桌面端）

-## 配置文件编辑器（旧版）
+## 使用配置文件编辑器（legacy）

- 您可以前往 [ExamShowBoardEditor（已存档·只读）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest) 获取配置文件编辑器   
- 1. 运行解压出的 `GUI.exe`
- 2. 点击 `添加考试信息` 按钮添加考试信息   
-  - 输入考试科目名称   
+> [!caution]
+>
+> 配置文件编辑器(legacy)不再维护，如果您汇报使用此编辑器遇到的相关问题，开发者可能不会受理。
+
+您可以前往 [ExamShowBoardEditor（已存档·只读）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest) 获取配置文件编辑器
+
+1. 运行解压出的 `GUI.exe`
+2. 点击 `添加考试信息` 按钮添加考试信息
+  - 输入考试科目名称
  - 输入考试日期，格式为 `YYYY-MM-DD` ，例如 `2025-01-01`
  - 分别输入考试开始/结束时间，格式为 `HH:MM:SS` ，例如 `08:00:00`
  - 点击 `保存` 按钮保存输入的考试信息
- 3. 点击 `保存到json` 按钮保存到配置文件中
+3. 点击 `保存到json` 按钮保存到配置文件中
  - 输入考试标题
  - 输入考试副标题
  - 输入考场号
-  - 点击 `保存` 按钮导出配置文件   
+  - 点击 `保存` 按钮导出配置文件

 > [!tip]
 >
@ -70,4 +78,4 @@

 > [!tip]   
 >
->您可以将配置文件复制到 `U盘` 等存储介质中，以实现配置文件的转移及部署；您也可以使用[集控]以实现配置文件的分发及部署。   
+>您可以将配置文件复制到 `U盘` 等存储介质中，以实现配置文件的转移及部署；您也可以使用[集控](/management/)以实现配置文件的分发及部署。
--- a/src/community/README.md
+++ b/src/community/README.md
@ -0,0 +1,16 @@
+---
+icon: users
+index: true
+---
+
+# 讨论社区
+
+> [!warning]
+> 要加入讨论社区，您需要遵循相应讨论社区的[社区规范](./rules.md)。
+
+您也可以加入这些社区**寻求帮助**：
+
+- [QQ 群｜901670561](https://qm.qq.com/q/zDiEipHsaI) 该群聊比较活跃，平时灌水比较多，。~~并且有些抽象！~~喜欢闲聊的用户也可以加入该群。
+- [GitHub Discussions](https://github.com/ExamAware/ExamAware2-Desktop/discussions) 您也可以在 GitHub Discussion 提问以及和其它成员交流。
+
+如果您确定您遇到的问题是 **Bug** ，或者您想要提出一项**新功能**，请在对应仓库提交 **GitHub Issues** 。
--- a/src/community/contributing.md
+++ b/src/community/contributing.md
@ -0,0 +1,57 @@
+---
+icon: code-commit
+---
+
+# 向 ExamAware 文档做贡献
+
+> [!warning]
+>
+> 本页是关于 **ExamAware 文档** 的贡献指南，如果您要为 **ExamAware 系列应用** 做出贡献，请前往对应仓库。
+
+本文档的建设离不开广大用户的支持，感谢您考虑为本文档做出贡献❤️！在为本文档贡献之前，请先阅读本指南。
+
+本文档基于 [VuePress](https://vuepress.vuejs.org/) 搭建。了解 [VuePress](https://vuepress.vuejs.org/) 的用法对编写本文档很有帮助。
+
+本文档目前托管在 [GitHub Pages](https://pages.github.com/) 上。
+
+## 贡献准则
+
+- 使用小写文件名
+
+    VuePress 对 URL 链接大小写敏感，使用包含大写字母的文件名可能会出现一些问题。在命名文档和文件夹时请使用小写字母，并用`-`分割每个单词，例如：
+
+    ``` plaintext
+    example-doc.md
+    example-folder/
+        |- another-doc.md
+    ```
+
+- 将图片放置在仓库文件中
+
+    插入图片时请尽量直接将源文件插入到仓库文件中，不使用额外的 CDN / 图床承载图片，以便发布文档时自动将图片等文件打包到 GitHub Pages 上。插入的图片请放置在 `(文档目录)/image/(文档文件名)`下，例如：
+
+    ``` plaintext
+    example-doc.md
+    example-doc-2.md
+    image/
+        |- example-doc/
+        |   |- image1.png
+        |   |- image2.png
+        |- example-doc-2/
+            |- image1.png
+            |- image2.png
+    ```
+
+- 编写简单易读的文档
+
+    在编写文档时请尽量做到简单易读。必要时可以插入图片、Mermaid 图表等便于读者理解。
+
+## 合并更改
+
+您可以向本项目发起 [Pull Request](https://github.com/ExamAware/ExamAware-docs-next/pulls) 来合并您的更改。在发起 Pull Request 时，请简要地描述您做的更改。
+
+更改合并以后，您可以在 [在线文档](https://docs.examaware.us.kg/) 中看到您的更改。
+
+## 还有疑问？
+
+您可以加入 [QQ 群｜901670561](https://qm.qq.com/q/zDiEipHsaI) 与开发者和其他用户讨论。
--- a/src/community/rules.md
+++ b/src/community/rules.md
@ -0,0 +1,72 @@
+---
+author: Hello8693
+icon: scale-balanced
+---
+
+# 社区规范
+
+> [!note]
+>
+> 本规范适用于 ExamAware QQ 群组。
+
+欢迎来到 ExamAware 用户交流社区！您可以在这里讨论 ExamAware 应用相关内容，或者提出问题，也可以吹水闲聊。为保证良好的交流环境，在交流时请遵守以下规则！
+
+## 基本
+
+1. 交流时请遵守相关法律法规，禁止发布以下内容：
+    - 涉黄、涉赌、涉毒、恐怖暴力等违法违规内容
+    - 涉政、涉宗等敏感言论
+    - 侵犯他人隐私或冒充他人的内容
+    - 其它违反相关法律法规的内容
+
+2. 禁止发布包含病毒、木马等恶意内容的文件和链接。
+
+3. 可以适度复读，不得单人刷屏。
+
+4. 在邀请机器人进群时请先征得管理员同意。
+
+5. 不要频繁催更。
+
+6. 不提倡讨论 LGBTQ 相关内容。
+
+7. 如果您不确定所发消息是否违反上述规定，请最好别发。
+
+## 提问/求助
+
+1. 提问前请在这些地方查找是否有您要问的问题：
+    - [本文档](https://https://docs.examaware.us.kg/)
+    - 对应仓库 **Issues**
+    - [必应](https://cn.bing.com/)、[百度](https://www.baidu.com/)等搜索引擎
+    
+    如果这些地方没能解答您的问题，您再在社区里提问。
+
+    > [!note]
+    >
+    > 如果您的问题能轻易地在上面列举的链接中通过搜索等方式找到，很可能没有人会回答您的提出的问题。
+
+2. 提问和求助时请提供足够的信息，提供越多有效信息越能得到帮助。您至少应该提供这些信息：
+    - 系统环境（如操作系统版本等）
+    - 程序日志
+    - 错误堆栈信息（如有）
+
+    > 在没有错误日志的情况下诊断任何问题无异于闭眼开车！
+    > —— Apache 官方文档 Gettings Started 篇章
+
+3. 如果您想要反馈应用 **Bug** ，或者要提出一个功能请求，请在对应仓库提交 **Issues** 。（开发者可能会遗漏群聊里反馈的 Bug 或功能请求。）
+    
+如果您不知道如何有效、精准地表述您的问题，建议您先阅读[《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)。
+
+## 违规处理
+
+如果您违反上述规定，可能会视情节轻重受到下述处罚：
+
+- 口头警告、撤回违规内容
+- 移出群聊并添加黑名单
+
+处罚力度会随着违规次数增加而升级。如果您对处理结果有异议，请在处理后 48 小时内联系管理员申诉。
+
+如果您发现讨论区有发现异常情况，可以通过私聊向管理员反映。
+
+## 结语
+
+感谢您对本规范的支持与配合！希望大家能共同营造一个友好、和谐的交流社区。
--- a/src/management/examschedule/management-config.md
+++ b/src/management/examschedule/management-config.md
@ -5,7 +5,7 @@
 > 请先准备好配置文件，详情请参阅[编写配置文件](src/app/profile/faq.md)。

 ## 使用Python部署
- - 确保已安装 [Python](https://www.python.org/downloads/)。   
+ - 确保已安装 [Python](https://www.python.org/downloads/) 环境
 - 下载 [ExamSchedule](https://github.com/ExamAware/ExamSchedule) 最新源码
 - 在项目目录执行以下命令启动本地服务器：
    ```bash
@ -14,7 +14,8 @@
 - 打开浏览器，访问 `http://localhost:8000` 或`http://IP:8000/`即可查看考试安排。 
  
 > [!tip]
-> 可自行修改8000端口为您设置的端口。
+>
+> 可自行修改8000端口为您需要的端口。

 ## 使用宝塔面板部署
 - 确保已安装[宝塔面板](https://www.bt.cn/new/download.html)   
@ -25,11 +26,13 @@
 ![bt2](../images/bt02.png)
 - 在 `网站根目录` 中上传[仓库](https://github.com/ExamAware/ExamSchedule)中最新版的项目代码。   
 - 点击 `确定` 即可完成部署。
+
 > [!tip]
 >
 >如果您没有域名，可以前往[购买域名](https://www.dynadot.com/?s59Ms8lK8u7gQ)。
->或者您也可以直接使用IP+端口直连访问。
 >
+>或者您也可以直接使用IP+端口直连访问。
+

 ## 使用GitHub Page部署

@ -37,11 +40,11 @@
 - 在GitHub仓库中，进入 `Settings` -> `Pages`。
 - 在 `Source` 部分选择 `main` 分支并保存。
 ![gh-pages](../images/gh01.png)
- GitHub Pages 将会自动部署项目，稍后即可通过提供的URL访问。   
+- GitHub Pages 将会自动部署项目，稍后即可通过提供的URL访问。
+
 > [!tip]
 >
 > 您可以在`Custom domain`部分填入您的自定义域名，并将您的自定义域名`CNAME`解析到`{owner}.github.io`。
->   

 ## 使用IIS部署
 - 开启IIS功能     
@ -77,8 +80,8 @@
 6.最后，在浏览器中输入您的网卡地址(教程中的地址为`192.168.1.16`)，看到如下图片即部署成功   
 ![iis-10](../images/iis10.png)
 > [!tip]
-> 如果您希望在公网访问，需要在域名提供商处添加A记录，将域名解析到您的服务器IP地址，并填写正确的主机名。   
 >
+> 如果您希望在公网访问，需要在域名提供商处添加A记录，将域名解析到您的服务器IP地址，并填写正确的主机名。
 
 # 终极部署方案
 都不会部署？或者……尝试终极解决方案：