diff options
| author | John Olheiser <john.olheiser@gmail.com> | 2023-04-27 22:33:41 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-28 11:33:41 +0800 |
| commit | bb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3 (patch) | |
| tree | 3447bb1fc8d376cd401b2491be7d4d2aed314913 /docs/content/doc/administration/logging-documentation.en-us.md | |
| parent | 83022013c83feb5488952baea3ef0be818dfce21 (diff) | |
| download | gitea-bb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3.tar.gz gitea-bb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3.zip | |
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>
Diffstat (limited to 'docs/content/doc/administration/logging-documentation.en-us.md')
| -rw-r--r-- | docs/content/doc/administration/logging-documentation.en-us.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/content/doc/administration/logging-documentation.en-us.md b/docs/content/doc/administration/logging-documentation.en-us.md index 029eb5de09..3b2bf80769 100644 --- a/docs/content/doc/administration/logging-documentation.en-us.md +++ b/docs/content/doc/administration/logging-documentation.en-us.md @@ -5,6 +5,8 @@ slug: "logging-configuration" weight: 40 toc: false draft: false +aliases: + - /en-us/logging-configuration menu: sidebar: parent: "administration" @@ -29,7 +31,7 @@ As mentioned below, there is a fully functional log output by default, so it is ## Collecting Logs for Help -To collect logs for help and issue report, see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}}). +To collect logs for help and issue report, see [Support Options]({{< relref "doc/help/support.en-us.md" >}}). ## The `[log]` section |