📝 Docs: update FAQ && ISSUE_TEMPLATE

Molunerfinn · May 5, 2020 · 2c57a27 · 2c57a27 · ZonuyCode · Oct 30, 2020
1 parent b6e3adb
commit 2c57a27
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 30 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,30 +1,34 @@
 <!--
 PicGo Issue 模板
 请依照该模板来提交，否则将会被关闭。
-**提问之前请注意你看过FAQ、配置手册以及那些被关闭的issues。否则同样的提问也会被关闭！**
+**提问之前请注意你看过 FAQ、配置手册以及那些被关闭的 issues。否则同样的提问也会被关闭！**
 -->
 
+**声明：我已经仔细看过 [文档](https://picgo.github.io/PicGo-Doc/)、[FAQ](https://github.com/Molunerfinn/PicGo/blob/dev/FAQ.md)、和搜索过已经关闭的 [issues](https://github.com/Molunerfinn/PicGo/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed) 后依然没有找到答案，所以才发了一个新的 issue。**
+
 ## 问题类型
 
-<!-- 你要提交的是Bug Report还是Feature Request？-->
+<!-- 你要提交的是 Bug Report 还是 Feature Request？-->
 
-## PicGo的相关信息
+## PicGo 的相关信息
 
-<!-- 版本、所在平台（Mac或者Windows） -->
+<!-- PicGo 的版本、所在平台（Mac 或者 Windows 或者 Linux） -->
 
 ## 问题重现
 
-<!-- 如果是Bug Report请填写本项 -->
+<!-- 如果是 Bug Report 请填写本项 -->
 <!-- 请附上相关截图 -->
+<!-- 请附上 PicGo 的相关报错日志（用文本的形式）否则无法判断原因-->
+<!-- 报错日志可以在 PicGo 设置 -> 设置日志文件 -> 点击打开 后找到 -->
 
 ## 功能请求
 
-<!-- 如果是Feature Request请填写本项 -->
+<!-- 如果是 Feature Request 请填写本项 -->
 <!-- 详细描述你所预想的功能或者是现有功能的改进。 -->
 
 ---
 
 <!-- 
-  最后，喜欢PicGo的话不妨给它点个star~
+  最后，喜欢 PicGo 的话不妨给它点个 star~
   如果可以的话，请我喝杯咖啡？首页有赞助二维码，谢谢你的支持！ 
  -->
diff --git a/FAQ.md b/FAQ.md
@@ -1,58 +1,59 @@
 ## 常见问题
 
-> 在使用PicGo期间你会遇到很多问题，不过很多问题其实之前就有人提问过，也被解决，所以你可以先看看[使用文档](https://github.com/Molunerfinn/PicGo/wiki/%E8%AF%A6%E7%BB%86%E7%AA%97%E5%8F%A3%E7%9A%84%E4%BD%BF%E7%94%A8#%E8%87%AA%E5%AE%9A%E4%B9%89%E5%BF%AB%E6%8D%B7%E9%94%AE)，这份FAQ，以及那些被关闭的[issues](https://github.com/Molunerfinn/PicGo/issues?q=is%3Aissue+is%3Aclosed)，应该能找到答案。
+> 在使用 PicGo 期间你会遇到很多问题，不过很多问题其实之前就有人提问过，也被解决，所以你可以先看看 [使用文档](https://picgo.github.io/PicGo-Doc/zh/guide/getting-started.html#%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B)，这份 FAQ，以及那些被关闭的 [issues](https://github.com/Molunerfinn/PicGo/issues?q=is%3Aissue+is%3Aclosed)，应该能找到答案。
 
-## 1.七牛图床上传图片成功后无法显示或图片无`http://`前缀
+## 1. 七牛图床上传图片成功后，相册里无法显示或图片无`http://`前缀
 
 通常是你的七牛图床配置里的`设定访问网址`没有加上`http://`或者`https//`头。
 
 参考：[issue#79](https://github.com/Molunerfinn/PicGo/issues/79)
 
-## 2.能否支持图床远端同步删除
+## 2. 能否支持图床远端同步删除
 
-不能。有些图床（比如微博图床、SM.MS、Imgur等）不支持后台管理，为了架构统一不支持远端删除。
+不能。有些图床（比如微博图床、SM.MS、Imgur 等）不支持后台管理，为了架构统一不支持远端删除。
 
-## 3.能否支持上传视频文件
+## 3. 能否支持上传视频文件
 
-目前不能。2.0版本出来后将会支持插件系统，届时如果有人开发了相应的插件理论可以支持任意文件上传。
+目前不能。如果有人开发了相应的插件理论可以支持任意文件上传。
 
-## 4.微博图床上传之后无法显示预览图
+## 4. 微博图床上传之后无法显示预览图
 
 通常是挂了全局代理导致的。
 
 参考：[issue36](https://github.com/Molunerfinn/PicGo/issues/36)
 
-## 5.能否支持某某某图床
+## 5. 能否支持某某某图床
 
-截止v1.6，PicGo支持了如下图床：
+截止 v1.6，PicGo 支持了如下图床：
 
 - `微博图床` v1.0
 - `七牛图床` v1.0
-- `腾讯云COS v4\v5版本` v1.1 & v1.5.0
+- `腾讯云 COS v4\v5 版本` v1.1 & v1.5.0
 - `又拍云` v1.2.0
 - `GitHub` v1.5.0
 - `SM.MS` v1.5.1
-- `阿里云OSS` v1.6.0
+- `阿里云 OSS` v1.6.0
 - `Imgur` v1.6.0
 
-所以本体内将不会再支持其他图床。待2.0版本出来支持插件系统后可以由其他开发者开发相应的图床插件用以支持其他图床。
+所以本体内将不会再支持其他图床。需要其他图床支持可以参考目前已有的三方 [插件](https://github.com/PicGo/Awesome-PicGo)，如果还是没有你所需要的图床欢迎开发一个插件供大家使用。
 
-## 6.一个图床设置多个信息
+## 6. 一个图床设置多个信息
 
 不能。因为目前的架构只支持一个图床一份信息。
 
-## 7.v2.0版本有什么新功能
+## 7. GitHub 图床有时能上传，有时上传失败
 
-在不改变PicGo现有使用界面和使用习惯的基础上，将会重构整个底层`传输->转换->上传`的架构，使其能够支持插件系统，方便其他开发者基于PicGo的底层进行二次开发。
+1. GitHub 图床不支持上传同名文件，如果有同名文件上传，会报错。建议开启 `时间戳重命名` 避免同名文件。
+2. GitHub 服务器和国内 GFW 的问题会导致有时上传成功，有时上传失败，无解。想要稳定请使用付费云存储，如阿里云、腾讯云等，价格也不会贵。
 
-理论上有了插件系统之后，其他开发者能够支持如下功能：
+## 8. Mac 上无法打开 PicGo 的主窗口界面
 
-1. 能够实现上传前图片压缩
-2. 能够通过图片url实现上传图片 -> 更深入地可以批量地实现图床的迁移
-3. 能够支持其他图床甚至是自己的图床
+PicGo 在 Mac 上是一个顶部栏应用，在 dock 栏是不会有图标的。要打开主窗口，请右键或者双指点按顶部栏 PicGo 图标，选择「打开详细窗口」即可打开主窗口。
 
-等等。
+## 9. 上传失败，或者是服务器出错
 
-届时底层架构将会独立出来成为一个独立的npm包，能够直接在命令行里调用。
-
-目前开发进度可以参考[PicGo-Core](https://github.com/Molunerfinn/PicGo-Core)。
+1. PicGo 自带的图床都经过测试，上传出错一般都不是 PicGo 自身的原因。如果你用的是 GitHub 图床请参考上面的第 7 点。
+2. 检查 PicGo 的日志（报错日志可以在 PicGo 设置 -> 设置日志文件 -> 点击打开 后找到），看看 `[PicGo Error]` 的报错信息里有什么关键信息
+   1. 先自行搜索 error 里的报错信息，往往你能百度或者谷歌出问题原因，不必开 issue。
+   2. 如果有带有 `401` 、`403` 等 `40X` 状态码字样的，不用怀疑，就是你配置写错了，仔细检查配置，看看是否多了空格之类的。
+   3. 如果带有 `HttpError`、`RequestError` 、 `socket hang up` 等字样的说明这是网络问题，我无法帮你解决网络问题，请检查你自己的网络，是否有代理，DNS 设置是否正常等。