deploy: 11f6ada

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2f2227c283898f0fb801f801d14777c2
+tags: d77d1c0d9ca2f4c8421862c7c5a0d620

_sources/building.md

@@ -0,0 +1,49 @@
+# 构建网站
+
+## Jupyter Book 构建网站
+
+地震“学”所有教程网站都使用文档生成工具 [Jupyter Book](https://jupyterbook.org/) 构建。
+读者可以按照如下步骤在自己的计算机上构建网站。
+
+````{dropdown} 安装 git 和 Python
+以下步骤假定用户已安装版本控制工具 git 和 Python。
+
+若未安装 git，可以使用以下命令安装或更新 git：
+
+若未安装 Python，建议通过 :doc:`Anaconda <software:anaconda/index>`  来安装和管理 Python。
+````
+
+:::{note}
+以下步骤以[地震“学”科研入门教程](https://seismo-learn.org/seismology101/)为例。
+构建其他文档时只需做简单替换即可：
+
+- 构建文档[地震“学”软件](https://seismo-learn.org/software/): 将 `seismology101` 改成 `software`
+- 构建文档[地震“学”参考书](https://seismo-learn.org/seismology/): 将 `seismology101` 改成 `seismology`
+:::
+
+1. 下载文档源码
+   ```
+   # 克隆源码，并进入源码目录
+   $ git clone --depth=50 https://github.com/seismo-learn/seismology101.git
+   $ cd seismology101
+   ```
+
+2. 创建虚拟环境
+   ```
+   $ conda env create -f environment.yml
+   ```
+
+3. 编译生成 HTML 格式的文档
+   ```
+   $ conda activate seismo-learn
+   $ make html
+   ```
+
+4. 生成的文档位于 {file}`_build/html/` 目录下，直接用浏览器打开
+   {file}`_build/html/index.html` 即可在本地预览。
+
+## Hugo 构建网站
+
+[地震学主站](https://seismo-learn.org/)和[地震“学”链接](https://seismo-learn.org/links/)是由静态网站生成器 [Hugo](https://gohugo.io/) 构建生成的，具体构建方法请参考他们
+源码网址里的 {file}`README.md` 文件。此外，[地震“学”链接](https://seismo-learn.org/links/)使用的主题是我们基于 [Bootstrap](https://getbootstrap.com/) 框架和 [Font Awesome](https://fontawesome.com/)
+精美图标自定义的。

_sources/general-guidelines.md

@@ -0,0 +1,51 @@
+# 维护指南
+
+读者可以阅读以下维护指南，以便更快、更有效地参与到文档的维护与更新之中。
+
+## 维护与更新
+
+文档的维护与更新主要包括几个方面：
+
+- 修正错别字、语句不通等
+- 修正文档中的错误或不清晰的描述
+- 修正 Markdown 文件语法错误导致的显示问题
+- 调整章节结构，使文档条理更清晰
+- 建议或者编写新章节或新文档
+
+可以通过如下几种方式参与文档的维护与更新：
+
+1. 修改文档源码并提交 Pull Request（不熟悉 Pull Request 的读者可以参考 {doc}`pull-request`）
+2. 在 GitHub 上的文档源码仓库下提交 Issue
+3. 在 GitHub 上的文档源码仓库下的 Discussions 上留言（也可以直接点击文档网页左下角的“参与讨论”）
+
+## 分支模型
+
+GitHub 上托管的文档仓库中存在如下长期分支：
+
+- `main`: 主分支，对应最新版本的文档源码
+- `gh-pages`: 存放文档网页的分支，自动更新，无需人工修改
+
+其它分支均属于短期分支，在合并到 `main` 分支后会删除。
+
+## 文档风格
+
+### 文件命名
+
+每个源文件都会被转换成一个单独的网页。因而，确定文件名时应慎重，一旦确定，尽量不要再改动。
+由于 Windows 不区分文件名大小写，故而 {file}`option-B.md` 和 {file}`option-b.md`
+在 Windows 下会出现冲突。我们使用的文件的命名规则是：
+
+- 文件名一律采用小写字母
+- 文件名应尽量使用单词全称，避免使用各种形式的简写
+- 若文件名中含多个单词，应使用连字符 (hyphen) {kbd}`-` 连接
+
+### 文件风格
+
+1. 所有教程均采用 Markdown  语言编写，可参考 {doc}`Markdown 教程 <seis101:programming/markdown>` 学习其常用语法。
+3. 所有 Bash 命令前应加上 Shell 提示符 `$` 以表示该命令为 Shell 命令
+4. 中文字符与英文字符和数字之间应加上空格，如 `中文 ABC 中文` 而非 `中文ABC中文`，
+   `中文 123 中文` 而非 `中文123中文`
+5. 标点符号采用全角，如 `，`、`。`、`：`、`、`、`？` 等。
+   标点符号与中文字符、英文字符以及数字之间不需加空格。
+6. 图片应在保证清晰度的前提下尽可能小。可以使用 [squoosh 在线工具](https://squoosh.app/)
+   进行压缩。

_sources/index.md

@@ -0,0 +1,23 @@
+# 地震“学”贡献指南
+
+> **欢迎读者参与到地震“学”文档的维护与更新中！我们都是地震学的干饭人！**
+
+本指南主要为了方便读者向地震“学”提供反馈和贡献。我们欢迎任何促进地震学中文社区交流和发展
+的反馈和贡献。例如，修正错别字、语句不通；调整章节结构，使教程条理更清晰；
+建议或者编写新章节或新文档等等。
+
+读者提供反馈和贡献时，只需阅读以下五部分内容：
+
+1. {doc}`general-guidelines`：维护与更新文档的一些注意事项
+2. {doc}`building`：在自己计算机上构建文档
+3. {doc}`pull-request`：提交 Pull Request 的流程
+
+地震“学”维护者还需要注意的内容：
+
+6. {doc}`maintainer-notes`：维护者的部分注意事项
+7. {doc}`repositories`：地震“学”在 GitHub 上托管的所有仓库
+
+:::{note}
+读者在提供反馈和贡献时，若在某些方面遇到困难（如不熟悉某些事项），我们鼓励读者通过{doc}`general-guidelines`中的任意方式联系我们来获取协助。任何指南或规则只是为了方
+便读者提供反馈和贡献，并不是约束。
+:::

_sources/maintainer-notes.md

@@ -0,0 +1,40 @@
+# 维护者备忘单
+
+以下总结地震“学”维护者的部分注意事项。
+
+## GitHub 仓库设置
+
+地震“学”所有文档源码托管在 [GitHub](https://github.com/seismo-learn) 上。
+我们一般对 GitHub 上托管的文档仓库做一定设置。可以参考已存在的仓库进行配置，如[地震“学”科研入门教程](https://github.com/seismo-learn/seismology101)。
+
+在 “Settings” 的 “Options” 选项中：
+
+- “Features” 不使用 Wikis、Projects、Sponsorships
+- “Merge button” 选择 Allow squash merging、Allow auto-merge、Automatically delete head branches
+- “GitHub Pages” 的 Source 选择 gh-pages 分支，并勾选 Enforce HTTPS
+
+在 “Settings” 的 “Branches” 选项中，设置 main 分支的保护规则。
+
+在 “Settings” 的 “Secrets” 选项中，设置 Organization secrets。
+
+## 命令行工具
+
+我们使用 git 进行版本控制，一些编辑器或 IDE 也集成了 git。此外，也可以使用一些高效的
+命令行工具。
+
+[GitHub CLI](https://cli.github.com/) 是 GitHub 官方命令行工具，可以在终端中处理
+Pull Request、Issue 等，例如:
+
+```
+# 提交 Pull Request
+$ gh pr create
+
+# 提交 Pull Request，并申请 Reviewers
+$ gh pr create -r core-man,seisman
+```
+
+[hub](https://hub.github.com/) 是 git 的一个扩展，常用于同步本地和远程分支:
+
+```
+$ hub sync
+```