From cdfda0b0918794abc5cd763488c0e1ae633d8295 Mon Sep 17 00:00:00 2001 From: Norwin Roosen Date: Sat, 10 Jul 2021 14:30:30 +0200 Subject: [PATCH] make docs on debug logging more discoverable --- docs/content/doc/help/faq.en-us.md | 3 ++- docs/content/doc/help/seek-help.en-us.md | 11 ++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/content/doc/help/faq.en-us.md b/docs/content/doc/help/faq.en-us.md index 5c5835a47ce34..24643a821635b 100644 --- a/docs/content/doc/help/faq.en-us.md +++ b/docs/content/doc/help/faq.en-us.md @@ -110,7 +110,8 @@ A "login prohibited" user is a user that is not allowed to log in to Gitea anymo ## Setting up logging -- [Official Docs]({{< relref "doc/advanced/logging-documentation.en-us.md" >}}) +This is described [here]({{< relref "doc/advanced/logging-documentation.en-us.md" >}}). +For setting up debug logging for bug reports, see [here]({{< relref "doc/advanced/logging-documentation.en-us.md" >}}#debugging-problems). ## What is Swagger? diff --git a/docs/content/doc/help/seek-help.en-us.md b/docs/content/doc/help/seek-help.en-us.md index 1c01f94ae86be..d24f7f185e9ae 100644 --- a/docs/content/doc/help/seek-help.en-us.md +++ b/docs/content/doc/help/seek-help.en-us.md @@ -18,14 +18,15 @@ menu: - [Discord](https://discord.gg/Gitea) - [Discourse Forum](https://discourse.gitea.io/) -**NOTE:** When asking for support, it may be a good idea to have the following available so that the person helping has all the info they need: +**NOTE:** When asking for support, please always provide the following data, so that the person helping has all the info they need. This increases your chances of getting help significantly. -1. Your `app.ini` (with any sensitive data scrubbed as necessary) -2. The `gitea.log` (and any other appropriate log files for the situation) - * e.g. If the error is related to the database, the `xorm.log` might be helpful +1. The `gitea.log` (and any other appropriate log files for the situation) + * Learn [here]({{< relref "doc/advanced/logging-documentation.en-us.md" >}}#debugging-problems) how to enable debug logging to get the most useful logs. + * e.g. If the error is related to the database, the `xorm.log` might be helpful. +2. Your `app.ini` (with any sensitive data scrubbed as necessary) 3. Any error messages you are seeing 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. - * This will greatly improve the chance that the root of the issue can be quickly discovered and resolved. + * This will greatly improve the chance that the root of the issue can be quickly discovered and resolved. ## Bugs