chore(docs): add TOC for the md docs (#284)

Co-authored-by: Zijun Zhou <zzjzhou@ucdavis.edu>
wuhan2020 · Feb 2, 2020 · c91863c · c91863c
1 parent 522888b
commit c91863c
Show file tree

Hide file tree

Showing 13 changed files with 176 additions and 88 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,7 @@
+# 贡献指南
+
 <!-- TOC -->
-# WE PROVIDE ENGLISH VERSION, PLEASE CLICK [HERE](https://github.com/wuhan2020/wuhan2020/blob/master/CONTRIBUTING_EN.md)
+*WE PROVIDE ENGLISH VERSION, PLEASE CLICK [HERE](https://github.com/wuhan2020/wuhan2020/blob/master/CONTRIBUTING_EN.md)*
 
 - [贡献指南](#贡献指南)
   - [我要提交数据信息](#我要提交数据信息)
@@ -20,8 +22,8 @@
 
 <!-- /TOC -->
 
-# 贡献指南
 ## 我要提交数据信息
+
 **该仓库为数据主仓，所有数据由脚本自动提交导入，请不要在该仓库中直接提交数据信息，提交数据信息，请参考 [README](./README.md)**。
 
 > 本平台使用石墨文档收集数据信息，并由脚本定时以 PR 形式提交数据到该仓库，请不要在该仓库中直接修改数据文件。

diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md
@@ -1,34 +1,30 @@
-<!-- TOC -->
-
-- [Guide For contribution](#Guide For contribution)
-  - [To submit data](#To submit data)
-  - [To submit a new issue or initialize a pull request](#To submit a new issue or initialize a pull request)
-    - [0、To submit a new issue](#0To submit a new issue)
-    - [1、To claim task](#1To claim task)
-    - [2、To fork this repository](#2To fork this repository)
-    - [3、Clone the repository](#3Clone the repository)
-    - [4、To create a `branch`](#4To create a `branch`)
-    - [5、To modify content and submit](#5To modify content and submit)
-    - [6、Upstream repository change synchronization](#6Upstream repository change synchronization)
-    - [7、To push new branch to remote repository](#7To push new branch to remote repository)
-    - [8、To create a `Pull Request`](#8To create a `Pull Request`)
-    - [9、To resolve a merge conflict](#9To resolve a merge conflict)
-    - [10、After the merge , you can](#10After the merge , you can)
-  - [Robot specification](#Robot specification)
-  - [Meet us on Slack](#Meet us on Slack)
-
-<!-- /TOC -->
-
-# Guide For contribution
-## To submit data 
+# Guide For contribution <!-- omit in toc -->
+
+- [To submit data](#to-submit-data)
+- [To submit a new issue or initialize a pull request](#to-submit-a-new-issue-or-initialize-a-pull-request)
+  - [0、To submit a new issue](#0to-submit-a-new-issue)
+  - [1、To claim task](#1to-claim-task)
+  - [2、To fork this repository](#2to-fork-this-repository)
+  - [3、Clone the repository](#3clone-the-repository)
+  - [4、To create a `branch`](#4to-create-a-branch)
+  - [5、To modify content and submit](#5to-modify-content-and-submit)
+  - [6、Upstream repository change synchronization](#6upstream-repository-change-synchronization)
+  - [7、To push new branch to remote repository](#7to-push-new-branch-to-remote-repository)
+  - [8、To create a `Pull Request`](#8to-create-a-pull-request)
+  - [9、To resolve a merge conflict](#9to-resolve-a-merge-conflict)
+  - [10、After the merge, you can：](#10after-the-merge-you-can)
+- [Robot specification](#robot-specification)
+- [Meet us on Slack](#meet-us-on-slack)
+
+## To submit data
+
 **This is the main repository, all the data import is accomplished automatically by scripts. So please don’t submit data to this repository directly. To submit data , please check [README](./README.md)**。
 
 > This platform uses Shimo (a cloud-based productivity suite) to collect data. The data will be automatically submitted to the repository in the form of Rps by scripts.
 
-> Since there are lots of contributors, we won’t give everyone the authority 
+> Since there are lots of contributors, we won’t give everyone the authority
 to edit, please fill in a form of application [here](https://shimo.im/forms/YVJkGrGCWwQPTpqY/fill). We will invite you to input information to certain sheets or forms.
 
-
 ## To submit a new issue or initialize a pull request
 In this guide we will try describing how to submit a new issue or initialize a pull request as detailed as we can. Welcome to contribute to **wuhan2020** !
 
@@ -40,14 +36,14 @@ When submitting a new `issue`， please pay attention to the type of the `issue`
 
 -   hospital: information relating to hospitals
 -   factory: information relating to manufacturing and production
--   logistical: logistical information 
+-   logistical: logistical information
 -   hotel: information relating to hotels
 -   donation：information relating to donation
 -   clinic：information relating to voluntary clinic
 -   news：news update on this 2019-nCoV epidemic prevention
--   doc: about documentation 
--   bug： bug report 
--   feature: new features 
+-   doc: about documentation
+-   bug： bug report
+-   feature: new features
 
 ### 1、To claim task
 
@@ -128,7 +124,7 @@ If there have been changes to the upstream repo already, please run `rebase` at
 $ git rebase upstream/master
 ```
 
-### 7、To push new branch to remote repository 
+### 7、To push new branch to remote repository
 
 ```bash
 $ git push -f origin my-fix-branch:my-fix-branch
@@ -149,7 +145,7 @@ git commit --amend
 git push -f origin my-fix-branch
 ```
 
-### 9、To resolve a merge conflict 
+### 9、To resolve a merge conflict
 
 > Nota bene : if no conflict occurs, no need to do these
 
@@ -209,7 +205,7 @@ This project has been granted access to GitHub robot :`Menbotics`，it can：
 
 To know details of robot configuration, please check [hypertrons.json](./.github/hypertrons.json)，for example, to see who have the merging authority.
 
-## Meet us on Slack 
+## Meet us on Slack
 
 Furthermore , we have our [Slack group](https://join.slack.com/t/wuhan2020/shared_invite/enQtOTI2NTU1NzU3MTM2LWQ1YjIzMDllYjYzYTE1OTNhMWU4OTZkOGYzOGJhOWM2MzdlMjgwMmZiOWEzYTQwNmJkZDI4OWRmM2Q2ZDM1MTc)，where those channels for frontend backend and data sync are already prepared , meet us on Slack for a better communication both on technical and non-technical themes.
 Let's work together through this tough period to fight against the coronavirus!
diff --git a/DEV_ENV_SETUP.md b/DEV_ENV_SETUP.md
@@ -1,5 +1,7 @@
 # Github Repo 流程
+
 ## Git Repository 下载地址
+
 - 主要下载地址：https://github.com/wuhan2020/wuhan2020.git  -- wuhan（分支开始名称）
 - api项目下载地址： https://github.com/wuhan2020/api-server.git -- api
 - REST-api下载地址： https://github.com/wuhan2020/rest-api.git  -- rest
@@ -9,14 +11,14 @@
 - Json数据储存服务：https://github.com/wuhan2020/shimo-sheet2json.git --json
 
 # 开发程序员/测试 下载流程
-* `git clone *** ` 
+* `git clone *** `
 
 #### 拷贝不同repo到本地，最好每个issue创建自己不同branch，以项目名称开头创建分支，例如：
 * `用Python爬取最新疫情数据`, `分配给centurion-crawler` 使用 `wuhan-pythonspider-centurion`
 
 * `对于页面展示的建议`, `分配给zhuangbiaowei` 使用 `web-pagepresentation-zhuangbiaowei`
 
-#### 在本地branch进行更改后，push到远程分支master或者upstream. 由管理员统一整理决定更改或接受修改。 
+#### 在本地branch进行更改后，push到远程分支master或者upstream. 由管理员统一整理决定更改或接受修改。
 * `git branch {branch-name} `
 * `git branch -a`
 * `git checkout {branch-name}`
@@ -25,4 +27,3 @@
 * `git push`
 
 **保证你的pull request有作者提供足够的权限能够合并入master分支**
-
diff --git a/DEV_ENV_SETUP_EN.md b/DEV_ENV_SETUP_EN.md
@@ -1,4 +1,5 @@
 # Github Repo processing
+
 ## Git Repository Download Addresses
 - Major point wuhan2020：https://github.com/wuhan2020/wuhan2020.git  -- wuhan（branch prefix start with）
 - api project： https://github.com/wuhan2020/api-server.git -- api
@@ -14,7 +15,7 @@
 #### copy various repos to local，create branches according issues with your own name and project name, start with fixed prefix，for an example：
 * `用Python爬取最新疫情数据`, `allocated to centurion-crawler` with utilizing  `wuhan-pythonspider-centurion`
 
-* `对于页面展示的建议`, `allocated to zhuangbiaowei` with utilizing `web-pagepresentation-zhuangbiaowei` 
+* `对于页面展示的建议`, `allocated to zhuangbiaowei` with utilizing `web-pagepresentation-zhuangbiaowei`
 
 #### after to modification on local branch，push your change to remote branch to master or upstream. The authorize has right to decide use it or modify or merge
 * `git branch {branch-name} `
@@ -25,4 +26,3 @@
 * `git push`
 
 **Make sure your pull request has right or authorization to be merged to master, if it cannot be, please contact author of project, make sure it is not blocked**
-
diff --git a/FAQ.md b/FAQ.md
@@ -1,4 +1,9 @@
-# WE PROVIDE ENGLISH VERSION, PLEASE CLICK [HERE](https://github.com/wuhan2020/wuhan2020/blob/master/FAQ_EN.md)
+# WE PROVIDE ENGLISH VERSION, PLEASE CLICK [HERE](https://github.com/wuhan2020/wuhan2020/blob/master/FAQ_EN.md) <!-- omit in toc -->
+
+- [FAQ常见问题](#faq%e5%b8%b8%e8%a7%81%e9%97%ae%e9%a2%98)
+  - [项目运作类](#%e9%a1%b9%e7%9b%ae%e8%bf%90%e4%bd%9c%e7%b1%bb)
+  - [功能建议类](#%e5%8a%9f%e8%83%bd%e5%bb%ba%e8%ae%ae%e7%b1%bb)
+  - [其它答疑](#%e5%85%b6%e5%ae%83%e7%ad%94%e7%96%91)
 
 # FAQ常见问题
 

diff --git a/FAQ_EN.md b/FAQ_EN.md
@@ -1,4 +1,8 @@
-# FAQ Frequently asked questions
+# FAQ Frequently asked questions <!-- omit in toc -->
+
+- [Project operation-related questions](#project-operation-related-questions)
+- [Functional suggestions:](#functional-suggestions)
+- [Other questions:](#other-questions)
 
 ## Project operation-related questions
 
@@ -8,17 +12,17 @@ A: We do not create or invent information, we are simply the porter of informati
 
 **Q：What is the current status of Wuhan2020?**
 
-A：The main content of this project is data entry (information collection), and the main purpose of this project is for public research. Parts of this project also include technical development. As of now, the frontend projects are progressing smoothly, data synchronization projects are under development. We are in need for data entry volunteers, so prospective volunteers who would like to contribute in data entry should join the respective Slack channels.  
+A：The main content of this project is data entry (information collection), and the main purpose of this project is for public research. Parts of this project also include technical development. As of now, the frontend projects are progressing smoothly, data synchronization projects are under development. We are in need for data entry volunteers, so prospective volunteers who would like to contribute in data entry should join the respective Slack channels.
 
 **Q: What is the main communication method?**
 
 A：We have a communication group on Slack (URL: https://join.slack.com/t/wuhan2020/shared_invite/enQtOTI2NTU1NzU3MTM2LWQ1YjIzMDllYjYzYTE1OTNhMWU4OTZkOGYzOGJhOWM2MzdlMjgwMmZiOWEzYTQwNmJkZDI4OWRmM2Q2ZDM1MTc). We welcome anyone who is willing to contribute and discuss about technical and non-technical problems.
 
-Invitation link to Slack: 
+Invitation link to Slack:
 
 [https://join.slack.com/t/wuhan2020/shared_invite/enQtOTI2NTU1NzU3MTM2LWQ1YjIzMDllYjYzYTE1OTNhMWU4OTZkOGYzOGJhOWM2MzdlMjgwMmZiOWEzYTQwNmJkZDI4OWRmM2Q2ZDM1MTc](https://join.slack.com/t/wuhan2020/shared_invite/enQtOTI2NTU1NzU3MTM2LWQ1YjIzMDllYjYzYTE1OTNhMWU4OTZkOGYzOGJhOWM2MzdlMjgwMmZiOWEzYTQwNmJkZDI4OWRmM2Q2ZDM1MTc)
 
-Information about each channel is provided [here](./README_EN.md#Slack-Channel-Navigation). 
+Information about each channel is provided [here](./README_EN.md#Slack-Channel-Navigation).
 
 If you think the link has expired, please [raise an issue](https://github.com/wuhan2020/wuhan2020/issues) so we can reflect the changes.
 
@@ -31,7 +35,7 @@ A：Except for the default channels on Slack, we have:
 * #api-server (Python)
 * #data-sync
 
-Data entry-related channels are as follows: 
+Data entry-related channels are as follows:
 
 *  #data-hospital
 *  #data-hotel
@@ -46,23 +50,23 @@ A：We are currently looking for UI exchange design personnel, file management a
 
 **Q：What can we do to start working in data entry for Whan2020?**
 
-A：Since we have a great number of volunteers who expressed interest in this project, we are not giving open access of documents to everyone. Please click here: https://shimo.im/forms/YVJkGrGCWwQPTpqY/fill to submit an application. We will send out invitations for you to participate in data entry. We do not require any specific technical skills for data entry, and all volunteers are welcomed. 
+A：Since we have a great number of volunteers who expressed interest in this project, we are not giving open access of documents to everyone. Please click here: https://shimo.im/forms/YVJkGrGCWwQPTpqY/fill to submit an application. We will send out invitations for you to participate in data entry. We do not require any specific technical skills for data entry, and all volunteers are welcomed.
 
 **Q：What kind of data are we working with?**
 
-A：We work with organizing and compiling certified information from official websites. Sources of information include but are not limited to: official government statements, official media statements, hospital data, and industrial data. We are not considering non-certified information from any sources. 
+A：We work with organizing and compiling certified information from official websites. Sources of information include but are not limited to: official government statements, official media statements, hospital data, and industrial data. We are not considering non-certified information from any sources.
 
-## Functional suggestions: 
+## Functional suggestions:
 
-## Other questions: 
+## Other questions:
 
 **Q：How can I suggest for improvements?**
 
-A：When suggesting possible improvements, please try your best to include any possible solutions or tackle plan. 
+A：When suggesting possible improvements, please try your best to include any possible solutions or tackle plan.
 
 **Q：Why was my issue closed?**
 
-A：Issues will be closed after they have been solved. Repetitive issues or unprofessional issues will also be closed. 
+A：Issues will be closed after they have been solved. Repetitive issues or unprofessional issues will also be closed.
 
 ---
-Translator: [@Lili]() , Proofreader: [@JoeZijunZhou](https://github.com/JoeZijunZhou)
+Translator: [@Lili]() , Proofreader: [@JoeZijunZhou](https://github.com/JoeZijunZhou)
diff --git a/INFORMATION_GUIDE.md b/INFORMATION_GUIDE.md
@@ -1,5 +1,13 @@
-Translation: *[English](INFORMATION_GUIDE_EN.md)*
-
+Translation: *[English](INFORMATION_GUIDE_EN.md)* <!-- omit in toc -->
+
+- [信息收集指南](#%e4%bf%a1%e6%81%af%e6%94%b6%e9%9b%86%e6%8c%87%e5%8d%97)
+    - [医院](#%e5%8c%bb%e9%99%a2)
+  - [酒店](#%e9%85%92%e5%ba%97)
+    - [物流](#%e7%89%a9%e6%b5%81)
+    - [生产](#%e7%94%9f%e4%ba%a7)
+    - [捐赠](#%e6%8d%90%e8%b5%a0)
+    - [义诊](#%e4%b9%89%e8%af%8a)
+    - [在外武汉游客住宿信息](#%e5%9c%a8%e5%a4%96%e6%ad%a6%e6%b1%89%e6%b8%b8%e5%ae%a2%e4%bd%8f%e5%ae%bf%e4%bf%a1%e6%81%af)
 
 # 信息收集指南
 

diff --git a/INFORMATION_GUIDE_EN.md b/INFORMATION_GUIDE_EN.md
@@ -1,18 +1,25 @@
-# Data Collection Guide
+# Data Collection Guide <!-- omit in toc -->
+
+- [Hospital:](#hospital)
+- [Hotel:](#hotel)
+- [Logistics:](#logistics)
+- [Manufacturer:](#manufacturer)
+- [Donation:](#donation)
+- [Free medical consultation:](#free-medical-consultation)
 
 We have founded an information team. The information collected by our platform includes following types.
 
 Due to the large number of participants, the editing authority has limitation. Please fill the application form [here](https://shimo.im/forms/YVJkGrGCWwQPTpqY/fill). We will invite you to join us.
 
-For those who want to join the information team, please 
+For those who want to join the information team, please
 1. Scan the following WeChat QR Code:
 ![QRCode](./static/QRCode.jpeg)
 
 2. Register a Shimo.im account. When you are filling the application form, please make sure your email address is the same one as your registered Shimo.im account. You will be invited via this email address afterwards to collaborate with us for the information collection work. In your application, please select your working preference from following categories: hospital, hotel, logistics, free medical consultation, donation, and manufacturer. You can choose one or multiple categories. You will be re-assigned to another category if there are too many people in one category and there are demands in the other categories.
 
 3. Please be responsible to the epidemic area when you are entering any information and **_make sure the information is valid_**. For those information related to hospitals, hotels, logistics and donations, **_please attach official web link. For supplier information declaration, please append qualification certification, such as business certificate, industrial and commercial information, etc._** to make sure the validity of suppliers and already get the permission from the suppliers.
 
-4. Before entering any information, please verify the information source by yourself first. Do NOT enter information without official links and do NOT enter unconfirmed information. 
+4. Before entering any information, please verify the information source by yourself first. Do NOT enter information without official links and do NOT enter unconfirmed information.
 
 Our platform is using Shimo.im to collect information, and use script to push to this repo by using PR. **Do NOT edit files directly in this repo.**
 

diff --git a/README.md b/README.md
@@ -1,9 +1,25 @@
-# 简体中文 | [English](./README_EN.md) | [日本語](./README_JP.md) | [Italiano](./README_IT.md)
+# 简体中文 | [English](./README_EN.md) | [日本語](./README_JP.md) | [Italiano](./README_IT.md) <!-- omit in toc -->
 
 ### 志愿者入口 >>> [![Github](https://img.shields.io/badge/wuhan2020-官方公告-green.svg?style=for-the-badge&colorB=red)](WUHAN2020_OFFICIAL_ANNOUNCEMENT.md) [![Github](https://img.shields.io/badge/wuhan2020-OFFICIAL%20ANNOUNCEMENT-green.svg?style=for-the-badge&colorB=red)](WUHAN2020_OFFICIAL_ANNOUNCEMENT_EN.md)
 
 [wuhan2020社区官网](https://wuhan2020.github.io/zh-cn/)
 
+- [武汉新型冠状病毒防疫信息收集平台](#%e6%ad%a6%e6%b1%89%e6%96%b0%e5%9e%8b%e5%86%a0%e7%8a%b6%e7%97%85%e6%af%92%e9%98%b2%e7%96%ab%e4%bf%a1%e6%81%af%e6%94%b6%e9%9b%86%e5%b9%b3%e5%8f%b0)
+  - [协作流程](#%e5%8d%8f%e4%bd%9c%e6%b5%81%e7%a8%8b)
+  - [该平台主要开源项目](#%e8%af%a5%e5%b9%b3%e5%8f%b0%e4%b8%bb%e8%a6%81%e5%bc%80%e6%ba%90%e9%a1%b9%e7%9b%ae)
+    - [数据同步](#%e6%95%b0%e6%8d%ae%e5%90%8c%e6%ad%a5)
+    - [渐进式 Web 应用](#%e6%b8%90%e8%bf%9b%e5%bc%8f-web-%e5%ba%94%e7%94%a8)
+    - [API 服务](#api-%e6%9c%8d%e5%8a%a1)
+    - [地图可视化组件](#%e5%9c%b0%e5%9b%be%e5%8f%af%e8%a7%86%e5%8c%96%e7%bb%84%e4%bb%b6)
+    - [石墨表格同步组件](#%e7%9f%b3%e5%a2%a8%e8%a1%a8%e6%a0%bc%e5%90%8c%e6%ad%a5%e7%bb%84%e4%bb%b6)
+  - [数据提交](#%e6%95%b0%e6%8d%ae%e6%8f%90%e4%ba%a4)
+    - [石墨文档地址：](#%e7%9f%b3%e5%a2%a8%e6%96%87%e6%a1%a3%e5%9c%b0%e5%9d%80)
+  - [贡献指南](#%e8%b4%a1%e7%8c%ae%e6%8c%87%e5%8d%97)
+  - [信息收集指南](#%e4%bf%a1%e6%81%af%e6%94%b6%e9%9b%86%e6%8c%87%e5%8d%97)
+- [Slack交流群组](#slack%e4%ba%a4%e6%b5%81%e7%be%a4%e7%bb%84)
+  - [Slack频道导航](#slack%e9%a2%91%e9%81%93%e5%af%bc%e8%88%aa)
+- [FAQ常见问题 （持续更新，招募志愿者一起维护）](#faq%e5%b8%b8%e8%a7%81%e9%97%ae%e9%a2%98-%e6%8c%81%e7%bb%ad%e6%9b%b4%e6%96%b0%e6%8b%9b%e5%8b%9f%e5%bf%97%e6%84%bf%e8%80%85%e4%b8%80%e8%b5%b7%e7%bb%b4%e6%8a%a4)
+
 # 武汉新型冠状病毒防疫信息收集平台
 
 针对 2020 年初在武汉爆发的新型冠状病毒疫情，本项目旨在收集各医院、酒店、工厂、物流、捐赠、捐款、预防、治疗、动态等信息，统一收集，统一发布，以便各方之间进行信息互通，有效调配社会资源。