 Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com> 1 year ago Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com> 1 year ago Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com> 1 year ago |
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- ---
- date: "2018-05-21T15:00:00+00:00"
- title: "Support Options"
- slug: "support"
- sidebar_position: 20
- toc: false
- draft: false
- aliases:
- - /en-us/seek-help
- menu:
- sidebar:
- parent: "help"
- name: "Support Options"
- sidebar_position: 20
- identifier: "support"
- ---
-
- # Support Options
-
- - [Paid Commercial Support](https://about.gitea.com/)
- - [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:
-
- 1. Your `app.ini` (with any sensitive data scrubbed as necessary).
- 2. The Gitea logs, and any other appropriate log files for the situation.
- - When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs.
- - When using docker, use `docker logs --tail 1000 <gitea-container>` to collect logs.
- - By default, the logs are outputted to console. If you need to collect logs from files,
- you could copy the following config into your `app.ini` (remove all other `[log]` sections),
- then you can find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`).
-
- ```ini
- ; To show all SQL logs, you can also set LOG_SQL=true in the [database] section
- [log]
- LEVEL=debug
- MODE=console,file
- ```
-
- 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.
- 5. If you encounter slow/hanging/deadlock problems, please report the stack trace when the problem occurs.
- Go to the "Site Admin" -> "Monitoring" -> "Stacktrace" -> "Download diagnosis report".
-
- ## Bugs
-
- If you found a bug, please create an [issue on GitHub](https://github.com/go-gitea/gitea/issues).
-
- ## Chinese Support
-
- Support for the Chinese language is provided at [Our discourse](https://discourse.gitea.io/c/5-category/5) or QQ Group 328432459.
|
