mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-14 13:53:45 +00:00
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 <[email protected]>
This commit is contained in:
1 parent
8f60329397
commit
f072758afb
154 files changed
+277
-48
No files matched your search
Whitespace-only changes.
Whitespace-only changes.
Whitespace-only changes.
@@ -5,6 +5,8 @@ slug: adding-legal-pages
|
|||||||
weight: 110
|
weight: 110
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/adding-legal-pages
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "backup-and-restore"
|
|||||||
weight: 11
|
weight: 11
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/backup-and-restore
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "backup-and-restore"
|
|||||||
weight: 11
|
weight: 11
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/backup-and-restore
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "backup-and-restore"
|
|||||||
weight: 11
|
weight: 11
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-tw/backup-and-restore
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "cmd-embedded"
|
|||||||
weight: 20
|
weight: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/cmd-embedded
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "command-line"
|
|||||||
weight: 1
|
weight: 1
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/command-line
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "config-cheat-sheet"
|
|||||||
weight: 30
|
weight: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/config-cheat-sheet
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "config-cheat-sheet"
|
|||||||
weight: 30
|
weight: 30
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/config-cheat-sheet
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "customizing-gitea"
|
|||||||
weight: 100
|
weight: 100
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/customizing-gitea
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "customizing-gitea"
|
|||||||
weight: 100
|
weight: 100
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/customizing-gitea
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "email-setup"
|
|||||||
weight: 12
|
weight: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/email-setup
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "environment-variables"
|
|||||||
weight: 10
|
weight: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/environment-variables
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "environment-variables"
|
|||||||
weight: 10
|
weight: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/environment-variables
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "external-renderers"
|
|||||||
weight: 60
|
weight: 60
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/external-renderers
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "fail2ban-setup"
|
|||||||
weight: 16
|
weight: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/fail2ban-setup
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "fail2ban-setup"
|
|||||||
weight: 16
|
weight: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/fail2ban-setup
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "git-lfs-setup"
|
|||||||
weight: 12
|
weight: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/git-lfs-setup
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "https-setup"
|
|||||||
weight: 12
|
weight: 12
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/https-setup
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "logging-configuration"
|
|||||||
weight: 40
|
weight: 40
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/logging-configuration
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
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
|
## 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
|
## The `[log]` section
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "mail-templates"
|
|||||||
weight: 45
|
weight: 45
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/mail-templates
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "repo-indexer"
|
|||||||
weight: 45
|
weight: 45
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/repo-indexer
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "reverse-proxies"
|
|||||||
weight: 16
|
weight: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/reverse-proxies
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "reverse-proxies"
|
|||||||
weight: 16
|
weight: 16
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/reverse-proxies
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "search-engines-indexation"
|
|||||||
weight: 60
|
weight: 60
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/search-engines-indexation
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "signing"
|
|||||||
weight: 50
|
weight: 50
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/signing
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "administration"
|
parent: "administration"
|
||||||
|
|||||||
Whitespace-only changes.
Whitespace-only changes.
Whitespace-only changes.
Whitespace-only changes.
@@ -5,6 +5,8 @@ slug: "guidelines-backend"
|
|||||||
weight: 20
|
weight: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/guidelines-backend
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "guidelines-frontend"
|
|||||||
weight: 20
|
weight: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/guidelines-frontend
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "guidelines-refactoring"
|
|||||||
weight: 20
|
weight: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/guidelines-refactoring
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "localization"
|
|||||||
weight: 10
|
weight: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/localization
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "localization"
|
|||||||
weight: 20
|
weight: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/localization
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "localization"
|
|||||||
weight: 20
|
weight: 20
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-tw/localization
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "contributing"
|
parent: "contributing"
|
||||||
|
|||||||
Whitespace-only changes.
Whitespace-only changes.
Whitespace-only changes.
@@ -5,6 +5,8 @@ slug: "api-usage"
|
|||||||
weight: 40
|
weight: 40
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/api-usage
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "api-usage"
|
|||||||
weight: 40
|
weight: 40
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/api-usage
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "hacking-on-gitea"
|
|||||||
weight: 10
|
weight: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/hacking-on-gitea
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "hacking-on-gitea"
|
|||||||
weight: 10
|
weight: 10
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-cn/hacking-on-gitea
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "integrations"
|
|||||||
weight: 65
|
weight: 65
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/integrations
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "integrations"
|
|||||||
weight: 65
|
weight: 65
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-tw/integrations
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "migrations-interfaces"
|
|||||||
weight: 55
|
weight: 55
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/migrations-interfaces
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "migrations-interfaces"
|
|||||||
weight: 55
|
weight: 55
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /zh-tw/migrations-interfaces
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ slug: "oauth2-provider"
|
|||||||
weight: 41
|
weight: 41
|
||||||
toc: false
|
toc: false
|
||||||
draft: false
|
draft: false
|
||||||
|
aliases:
|
||||||
|
- /en-us/oauth2-provider
|
||||||
menu:
|
menu:
|
||||||
sidebar:
|
sidebar:
|
||||||
parent: "development"
|
parent: "development"
|
||||||
|
|||||||
Loaded 50 of 154 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user