如何参与网站的管理？

项目的网站使用Material for MkDocs框架，部署在GitHub Page上，是一个静态网站，即只能展示固定的文档，无法处理用户请求。

1. 从GitHub Repo拉取代码

网站项目的名称为SciMusic_website，里面包含生成静态网页的全部代码及文档。

SciMusic_website所在的代码仓库为：https://github.com/2horse9sun/SciMusic_website。

该仓库为私有仓库，访问仓库前，先请负责的同学把你添加到仓库成员中。

使用命令行进入合适的文件夹中，运行以下命令，clone整个项目：

git clone https://github.com/2horse9sun/SciMusic_website.git

然后，进入到项目中：

cd SciMusic_website

在项目根目录新建文件夹site，进入到site中：

cd site

网站静态页面SciMusic所在的仓库为：https://github.com/2horse9sun/SciMusic。

该仓库为公共仓库。

使用命令行进入合适的文件夹中，运行以下命令，clone整个项目：

git clone https://github.com/2horse9sun/SciMusic.git

把SciMusic文件夹内的文件全部复制到site中，并删除SciMusic。

2. 环境配置

根据Material for MkDocs网站上的Getting Started的教程，使用pip的方式配置好环境。

配置完成后，回到项目的根目录：

cd ..

运行以下命令：

mkdocs serve

就可以打开指定url，预览网站界面。

3. 如何添加文档

打开根目录的mkdocs.yml文件，找到最后的nav配置项：

nav:
  - 项目简介: index.md
  - 1. 总体设计: architecture/architecture.md
  - 2. 数据准备:
      - 2.1 数据收集: data_preparation/2.1 data_collection.md
      - 2.2 数据预处理: 
          - 2.2.1 图像分割: data_preparation/data_preprocessing/2.2.1 image_segmentation.md
          - 2.2.2 数据标注: data_preparation/data_preprocessing/2.2.2 data_annotation.md
          - 2.2.3 生成数据集: data_preparation/data_preprocessing/2.2.3 dataset_generation.md
  - 3. 模型设计: 
      - 3.1 model_1: model/3.1 model_1.md
      - 3.2 model_2: model/3.2 model_2.md
  - 4. 模型训练: 
      - 4.1 训练环境: training/4.1 training_settings.md
  - 5. 算法评估: evaluation/5. evaluation.md
  - 小程序设计: 
      - 1. 简介: wxapp/1. index.md
      - 2. 总体架构: wxapp/2. architecture.md
      - 3. 后台设计: 
        - 3.1 数据表设计: wxapp/backend/3.1 database_table_design.md 
        - 3.2 后台服务设计: wxapp/backend/3.2 service_design.md
      - 4. 前端设计:
        - 4.1 依赖库: wxapp/frontend/4.1 lib.md
        - 4.2 界面设计: wxapp/frontend/4.2 page_design.md 
      - 5. Become a developer: 
        - 5.0 Prerequisite: wxapp/develop/5.0 Prerequisite.md
        - 5.1 后台搭建: wxapp/develop/5.1 server_deploy.md
        - 5.2 后台维护: wxapp/develop/5.2 server_maintenance.md
        - 5.3 微信小程序搭建: wxapp/develop/5.3 wxapp_deploy.md
        - 5.4 Clean Code: wxapp/develop/5.4 clean_code.md
  - 会议记录: 
      - 2022: 
        - 20220212: meetings/2022/20220212.md 
        - 20220115: meetings/2022/20220115.md 
      - 2021:
        - 20211209: meetings/2021/20211209.md
        - 20211022: meetings/2021/20211022.md
        - 20210930: meetings/2021/20210930.md
        - 20210822: meetings/2021/20210822.md
        - 20210807: meetings/2021/20210807.md
        - 20210715: meetings/2021/20210715.md
        - 20210708: meetings/2021/20210708.md
        - 20210518: meetings/2021/20210518.md
        - 20210414: meetings/2021/20210414.md
        - 20210403: meetings/2021/20210403.md
      - 2019:
        - 20190727: meetings/2019/20190727.md
        - 20190623: meetings/2019/20190623.md
        - 20190522: meetings/2019/20190522.md
        - 20190509: meetings/2019/20190509.md
        - 20190417: meetings/2019/20190417.md
        - 20190410: meetings/2019/20190410.md
        - 20190403: meetings/2019/20190403.md
        - 20190322: meetings/2019/20190322.md
        - 20190308: meetings/2019/20190308.md
        - 20190301: meetings/2019/20190301.md
        - 20190202: meetings/2019/20190202.md
        - 20190111: meetings/2019/20190111.md
      - 2018:
        - 20181213: meetings/2018/20181213.md
        - 20181122: meetings/2018/20181122.md
        - 20181101: meetings/2018/20181101.md
        - 20180919: meetings/2018/20180919.md
        - 20180907: meetings/2018/20180907.md
        - 20180528: meetings/2018/20180528.md
        - 20180420: meetings/2018/20180420.md
        - 20180412: meetings/2018/20180412.md
        - 20180329: meetings/2018/20180329.md
        - 20180322: meetings/2018/20180322.md
        - 20180131: meetings/2018/20180131.md
      - 2017:
        - 20171117: meetings/2017/20171117.md
        - 20171110: meetings/2017/20171110.md
        - 20170914: meetings/2017/20170914.md
        - 20170731: meetings/2017/20170731.md
      - 2016:
        - 20161110: meetings/2016/20161110.md
        - 20161103: meetings/2016/20161103.md
        - 20161015: meetings/2016/20161015.md
        - 20160927: meetings/2016/20160927.md
        - 20160920: meetings/2016/20160920.md
  - 资源汇总: resources/resources.md
  - Change Log: changelog.md
  - How to contribute: 
    - 网站: contribute/contribute_to_website.md
    - 小程序: contribute/contribute_to_wxapp.md
    - 算法: contribute/contribute_to_algorithm.md

仔细观察可以发现：

1. 这里的结构完全对应网站左侧目录的结构。
2. 这里的文件路径完全对应项目根目录中docs文件夹下的文件路径。

综上所述，添加一篇新文档的步骤如下：

1. 在mkdocs.yml中的nav配置项下，模仿之前的文档，写入你想要添加的文档路径。
2. 在根目录中docs文件夹中对应的路径下，创建与上面对应的md文件。
3. 在命令行中运行mkdocs serve预览网页。

4. 网站上线

在本地添加/修改完文档且预览无误后，首先应当在changelog.md中记录下你所做的修改。

然后，命令行进入到项目的根目录（site的上一级），使用git提交代码。在commit时，应当简洁地描述所做的改动；在push之前应当先pull，获取最新代码。此时，你只是提交了生成静态网站所需的代码，而不是静态网站的代码。

最后，在根目录运行命令：

mkdocs build

这条命令的作用是在site文件夹内生成网站的源代码。现在，进入到site中：

cd site

然后，使用git提交代码，commit的message随意。此时，访问项目网站，应当能看到更新。

5. 文档规范

见：How to contribute > Template

6. 意见反馈

在仓库的Issue界面反馈问题。

Author: 冯旭

Create Time: 2022-02-19

Update Time: 2022-02-19