Skip to content

Commit 5f22e2d

Browse files
authored
Improve seek-help documents (#17895)
* Add pprof information to seek-help documents * Improve zh-cn and zh-tw documents
1 parent 6791aae commit 5f22e2d

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

docs/content/doc/help/seek-help.en-us.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,23 @@ menu:
2222

2323
1. Your `app.ini` (with any sensitive data scrubbed as necessary)
2424
2. The `gitea.log` (and any other appropriate log files for the situation)
25-
* e.g. If the error is related to the database, the `xorm.log` might be helpful
25+
* e.g. If the error is related to the database, the `xorm.log` might be helpful
2626
3. Any error messages you are seeing
2727
4. When possible, try to replicate the issue on [try.gitea.io](https://try.gitea.io) and include steps so that others can reproduce the issue.
28-
* This will greatly improve the chance that the root of the issue can be quickly discovered and resolved.
28+
* This will greatly improve the chance that the root of the issue can be quickly discovered and resolved.
29+
5. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs:
30+
1. Enable pprof in `app.ini` and restart Gitea
31+
```
32+
[server]
33+
ENABLE_PPROF = true
34+
```
35+
2. Trigger the bug, when Gitea gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP is `127.0.0.1` and port is `6060`)
36+
3. Report the output (the stack trace doesn't contain sensitive data)
2937
3038
## Bugs
3139
3240
If you found a bug, please create an [issue on GitHub](https://github.com/go-gitea/gitea/issues).
3341
3442
## Chinese Support
3543
36-
Support for the Chinese language is provided at [Our discourse](https://discourse.gitea.io/c/5-category/5).
44+
Support for the Chinese language is provided at [Our discourse](https://discourse.gitea.io/c/5-category/5) or QQ Group 328432459.

docs/content/doc/help/seek-help.zh-cn.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ menu:
1717

1818
如果您在使用或者开发过程中遇到问题,请到以下渠道咨询:
1919

20-
-[Github issue](https://github.com/go-gitea/gitea/issues)提问(因为项目维护人员来自世界各地,为保证沟通顺畅,请使用英文提问)
21-
- 中文问题到 [Gitea 论坛](https://discourse.gitea.io/c/5-category/5)提问
22-
- 访问 [Discord server - 英文](https://discord.gg/Gitea)
20+
- [GitHub Issue](https://github.com/go-gitea/gitea/issues) 提问(因为项目维护人员来自世界各地,为保证沟通顺畅,请使用英文提问)
21+
- 中文问题到 [Gitea 论坛](https://discourse.gitea.io/c/5-category/5) 提问
22+
- 访问 [Discord Gitea 聊天室 - 英文](https://discord.gg/Gitea)
2323
- 加入 QQ群 328432459 获得进一步的支持

docs/content/doc/help/seek-help.zh-tw.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@ menu:
2222

2323
1. 您的 `app.ini` (必要時清除掉任何機密資訊)
2424
2. `gitea.log` (以及任何有關的日誌檔案)
25-
* 例:如果錯誤和資料庫相關,提供 `xorm.log` 可能會有幫助
25+
* 例:如果錯誤和資料庫相關,提供 `xorm.log` 可能會有幫助
2626
3. 您看到的任何錯誤訊息
27-
5. 儘可能地在 [try.gitea.io](https://try.gitea.io) 觸發您的問題並記下步驟,以便其他人能重現那個問題。
28-
* 這將讓我們更有機會快速地找出問題的根源並解決它。
27+
4. 儘可能地在 [try.gitea.io](https://try.gitea.io) 觸發您的問題並記下步驟,以便其他人能重現那個問題。
28+
* 這將讓我們更有機會快速地找出問題的根源並解決它。
29+
5. 堆棧跟踪,[請參考英文文檔](https://docs.gitea.io/en-us/seek-help/)
2930

3031
## 錯誤回報
31-
如果您發現錯誤,請到 [Github 的 Issue](https://github.com/go-gitea/gitea/issues) 回報。
32+
33+
如果您發現錯誤,請到 [GitHub 的 Issue](https://github.com/go-gitea/gitea/issues) 回報。

0 commit comments

Comments
 (0)