Skip to content

Commit

Permalink
make docs on debug logging more discoverable
Browse files Browse the repository at this point in the history
  • Loading branch information
noerw committed Jul 10, 2021
1 parent 93d8393 commit cdfda0b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
3 changes: 2 additions & 1 deletion docs/content/doc/help/faq.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
11 changes: 6 additions & 5 deletions docs/content/doc/help/seek-help.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit cdfda0b

Please sign in to comment.