aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/administration
diff options
context:
space:
mode:
authorJohn Olheiser <john.olheiser@gmail.com>2023-04-27 22:33:41 -0500
committerGitHub <noreply@github.com>2023-04-28 11:33:41 +0800
commitbb25f85ce8f559fa3e9f462ad1027b5b5a8e2da3 (patch)
tree3447bb1fc8d376cd401b2491be7d4d2aed314913 /docs/content/doc/administration
parent83022013c83feb5488952baea3ef0be818dfce21 (diff)
downloadgitea-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')
-rw-r--r--docs/content/doc/administration/_index.en-us.md0
-rw-r--r--docs/content/doc/administration/_index.zh-cn.md0
-rw-r--r--docs/content/doc/administration/_index.zh-tw.md0
-rw-r--r--docs/content/doc/administration/adding-legal-pages.en-us.md2
-rw-r--r--docs/content/doc/administration/backup-and-restore.en-us.md2
-rw-r--r--docs/content/doc/administration/backup-and-restore.zh-cn.md2
-rw-r--r--docs/content/doc/administration/backup-and-restore.zh-tw.md2
-rw-r--r--docs/content/doc/administration/cmd-embedded.en-us.md2
-rw-r--r--docs/content/doc/administration/command-line.en-us.md2
-rw-r--r--docs/content/doc/administration/config-cheat-sheet.en-us.md2
-rw-r--r--docs/content/doc/administration/config-cheat-sheet.zh-cn.md2
-rw-r--r--docs/content/doc/administration/customizing-gitea.en-us.md2
-rw-r--r--docs/content/doc/administration/customizing-gitea.zh-cn.md2
-rw-r--r--docs/content/doc/administration/email-setup.en-us.md2
-rw-r--r--docs/content/doc/administration/environment-variables.en-us.md2
-rw-r--r--docs/content/doc/administration/environment-variables.zh-cn.md2
-rw-r--r--docs/content/doc/administration/external-renderers.en-us.md2
-rw-r--r--docs/content/doc/administration/fail2ban-setup.en-us.md2
-rw-r--r--docs/content/doc/administration/fail2ban-setup.zh-cn.md2
-rw-r--r--docs/content/doc/administration/git-lfs-support.en-us.md2
-rw-r--r--docs/content/doc/administration/https-support.en-us.md2
-rw-r--r--docs/content/doc/administration/logging-documentation.en-us.md4
-rw-r--r--docs/content/doc/administration/mail-templates.en-us.md2
-rw-r--r--docs/content/doc/administration/repo-indexer.en-us.md2
-rw-r--r--docs/content/doc/administration/reverse-proxies.en-us.md2
-rw-r--r--docs/content/doc/administration/reverse-proxies.zh-cn.md2
-rw-r--r--docs/content/doc/administration/search-engines-indexation.en-us.md2
-rw-r--r--docs/content/doc/administration/signing.en-us.md2
28 files changed, 51 insertions, 1 deletions
diff --git a/docs/content/doc/administration/_index.en-us.md b/docs/content/doc/administration/_index.en-us.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/administration/_index.en-us.md
diff --git a/docs/content/doc/administration/_index.zh-cn.md b/docs/content/doc/administration/_index.zh-cn.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/administration/_index.zh-cn.md
diff --git a/docs/content/doc/administration/_index.zh-tw.md b/docs/content/doc/administration/_index.zh-tw.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/administration/_index.zh-tw.md
diff --git a/docs/content/doc/administration/adding-legal-pages.en-us.md b/docs/content/doc/administration/adding-legal-pages.en-us.md
index 48aa21154c..6de145ce09 100644
--- a/docs/content/doc/administration/adding-legal-pages.en-us.md
+++ b/docs/content/doc/administration/adding-legal-pages.en-us.md
@@ -5,6 +5,8 @@ slug: adding-legal-pages
weight: 110
toc: false
draft: false
+aliases:
+ - /en-us/adding-legal-pages
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/backup-and-restore.en-us.md b/docs/content/doc/administration/backup-and-restore.en-us.md
index b1e5a6aee0..7dee038b57 100644
--- a/docs/content/doc/administration/backup-and-restore.en-us.md
+++ b/docs/content/doc/administration/backup-and-restore.en-us.md
@@ -5,6 +5,8 @@ slug: "backup-and-restore"
weight: 11
toc: false
draft: false
+aliases:
+ - /en-us/backup-and-restore
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/backup-and-restore.zh-cn.md b/docs/content/doc/administration/backup-and-restore.zh-cn.md
index 602657f419..1a8f620a8d 100644
--- a/docs/content/doc/administration/backup-and-restore.zh-cn.md
+++ b/docs/content/doc/administration/backup-and-restore.zh-cn.md
@@ -5,6 +5,8 @@ slug: "backup-and-restore"
weight: 11
toc: false
draft: false
+aliases:
+ - /zh-cn/backup-and-restore
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/backup-and-restore.zh-tw.md b/docs/content/doc/administration/backup-and-restore.zh-tw.md
index cab95217a3..07b9b0726b 100644
--- a/docs/content/doc/administration/backup-and-restore.zh-tw.md
+++ b/docs/content/doc/administration/backup-and-restore.zh-tw.md
@@ -5,6 +5,8 @@ slug: "backup-and-restore"
weight: 11
toc: false
draft: false
+aliases:
+ - /zh-tw/backup-and-restore
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/cmd-embedded.en-us.md b/docs/content/doc/administration/cmd-embedded.en-us.md
index 229a1c01d6..e418138ed7 100644
--- a/docs/content/doc/administration/cmd-embedded.en-us.md
+++ b/docs/content/doc/administration/cmd-embedded.en-us.md
@@ -5,6 +5,8 @@ slug: "cmd-embedded"
weight: 20
toc: false
draft: false
+aliases:
+ - /en-us/cmd-embedded
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/command-line.en-us.md b/docs/content/doc/administration/command-line.en-us.md
index 4d01d6e640..bf4578afec 100644
--- a/docs/content/doc/administration/command-line.en-us.md
+++ b/docs/content/doc/administration/command-line.en-us.md
@@ -5,6 +5,8 @@ slug: "command-line"
weight: 1
toc: false
draft: false
+aliases:
+ - /en-us/command-line
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/config-cheat-sheet.en-us.md b/docs/content/doc/administration/config-cheat-sheet.en-us.md
index be97edadb5..03cd93f91e 100644
--- a/docs/content/doc/administration/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/administration/config-cheat-sheet.en-us.md
@@ -5,6 +5,8 @@ slug: "config-cheat-sheet"
weight: 30
toc: false
draft: false
+aliases:
+ - /en-us/config-cheat-sheet
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/config-cheat-sheet.zh-cn.md b/docs/content/doc/administration/config-cheat-sheet.zh-cn.md
index 485d106234..eb015908bb 100644
--- a/docs/content/doc/administration/config-cheat-sheet.zh-cn.md
+++ b/docs/content/doc/administration/config-cheat-sheet.zh-cn.md
@@ -5,6 +5,8 @@ slug: "config-cheat-sheet"
weight: 30
toc: false
draft: false
+aliases:
+ - /zh-cn/config-cheat-sheet
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/customizing-gitea.en-us.md b/docs/content/doc/administration/customizing-gitea.en-us.md
index db31dc949b..54ce2a715f 100644
--- a/docs/content/doc/administration/customizing-gitea.en-us.md
+++ b/docs/content/doc/administration/customizing-gitea.en-us.md
@@ -5,6 +5,8 @@ slug: "customizing-gitea"
weight: 100
toc: false
draft: false
+aliases:
+ - /en-us/customizing-gitea
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/customizing-gitea.zh-cn.md b/docs/content/doc/administration/customizing-gitea.zh-cn.md
index 38729153f5..47230ddeb2 100644
--- a/docs/content/doc/administration/customizing-gitea.zh-cn.md
+++ b/docs/content/doc/administration/customizing-gitea.zh-cn.md
@@ -5,6 +5,8 @@ slug: "customizing-gitea"
weight: 100
toc: false
draft: false
+aliases:
+ - /zh-cn/customizing-gitea
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/email-setup.en-us.md b/docs/content/doc/administration/email-setup.en-us.md
index b8a3324f16..92ec95cce4 100644
--- a/docs/content/doc/administration/email-setup.en-us.md
+++ b/docs/content/doc/administration/email-setup.en-us.md
@@ -5,6 +5,8 @@ slug: "email-setup"
weight: 12
toc: false
draft: false
+aliases:
+ - /en-us/email-setup
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/environment-variables.en-us.md b/docs/content/doc/administration/environment-variables.en-us.md
index 83ff6f359a..92dbeb80c6 100644
--- a/docs/content/doc/administration/environment-variables.en-us.md
+++ b/docs/content/doc/administration/environment-variables.en-us.md
@@ -5,6 +5,8 @@ slug: "environment-variables"
weight: 10
toc: false
draft: false
+aliases:
+ - /en-us/environment-variables
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/environment-variables.zh-cn.md b/docs/content/doc/administration/environment-variables.zh-cn.md
index e148838581..cbc9787c35 100644
--- a/docs/content/doc/administration/environment-variables.zh-cn.md
+++ b/docs/content/doc/administration/environment-variables.zh-cn.md
@@ -5,6 +5,8 @@ slug: "environment-variables"
weight: 10
toc: false
draft: false
+aliases:
+ - /zh-cn/environment-variables
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/external-renderers.en-us.md b/docs/content/doc/administration/external-renderers.en-us.md
index a62c20e326..5e64bb847f 100644
--- a/docs/content/doc/administration/external-renderers.en-us.md
+++ b/docs/content/doc/administration/external-renderers.en-us.md
@@ -5,6 +5,8 @@ slug: "external-renderers"
weight: 60
toc: false
draft: false
+aliases:
+ - /en-us/external-renderers
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/fail2ban-setup.en-us.md b/docs/content/doc/administration/fail2ban-setup.en-us.md
index 420c6ae549..1638e0dd1f 100644
--- a/docs/content/doc/administration/fail2ban-setup.en-us.md
+++ b/docs/content/doc/administration/fail2ban-setup.en-us.md
@@ -5,6 +5,8 @@ slug: "fail2ban-setup"
weight: 16
toc: false
draft: false
+aliases:
+ - /en-us/fail2ban-setup
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/fail2ban-setup.zh-cn.md b/docs/content/doc/administration/fail2ban-setup.zh-cn.md
index 920d3f4af2..f4f3cff4ca 100644
--- a/docs/content/doc/administration/fail2ban-setup.zh-cn.md
+++ b/docs/content/doc/administration/fail2ban-setup.zh-cn.md
@@ -5,6 +5,8 @@ slug: "fail2ban-setup"
weight: 16
toc: false
draft: false
+aliases:
+ - /zh-cn/fail2ban-setup
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/git-lfs-support.en-us.md b/docs/content/doc/administration/git-lfs-support.en-us.md
index 95f4b95887..884b19896a 100644
--- a/docs/content/doc/administration/git-lfs-support.en-us.md
+++ b/docs/content/doc/administration/git-lfs-support.en-us.md
@@ -5,6 +5,8 @@ slug: "git-lfs-setup"
weight: 12
toc: false
draft: false
+aliases:
+ - /en-us/git-lfs-setup
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/https-support.en-us.md b/docs/content/doc/administration/https-support.en-us.md
index f5cd286823..d59ae2e8ee 100644
--- a/docs/content/doc/administration/https-support.en-us.md
+++ b/docs/content/doc/administration/https-support.en-us.md
@@ -5,6 +5,8 @@ slug: "https-setup"
weight: 12
toc: false
draft: false
+aliases:
+ - /en-us/https-setup
menu:
sidebar:
parent: "administration"
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
diff --git a/docs/content/doc/administration/mail-templates.en-us.md b/docs/content/doc/administration/mail-templates.en-us.md
index bc4b2ead30..0740ccaa5f 100644
--- a/docs/content/doc/administration/mail-templates.en-us.md
+++ b/docs/content/doc/administration/mail-templates.en-us.md
@@ -5,6 +5,8 @@ slug: "mail-templates"
weight: 45
toc: false
draft: false
+aliases:
+ - /en-us/mail-templates
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/repo-indexer.en-us.md b/docs/content/doc/administration/repo-indexer.en-us.md
index 11ce547a0d..81d2243476 100644
--- a/docs/content/doc/administration/repo-indexer.en-us.md
+++ b/docs/content/doc/administration/repo-indexer.en-us.md
@@ -5,6 +5,8 @@ slug: "repo-indexer"
weight: 45
toc: false
draft: false
+aliases:
+ - /en-us/repo-indexer
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/reverse-proxies.en-us.md b/docs/content/doc/administration/reverse-proxies.en-us.md
index 5132ee83f1..d11552bb9f 100644
--- a/docs/content/doc/administration/reverse-proxies.en-us.md
+++ b/docs/content/doc/administration/reverse-proxies.en-us.md
@@ -5,6 +5,8 @@ slug: "reverse-proxies"
weight: 16
toc: false
draft: false
+aliases:
+ - /en-us/reverse-proxies
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/reverse-proxies.zh-cn.md b/docs/content/doc/administration/reverse-proxies.zh-cn.md
index e622773df1..6504f7209b 100644
--- a/docs/content/doc/administration/reverse-proxies.zh-cn.md
+++ b/docs/content/doc/administration/reverse-proxies.zh-cn.md
@@ -5,6 +5,8 @@ slug: "reverse-proxies"
weight: 16
toc: false
draft: false
+aliases:
+ - /zh-cn/reverse-proxies
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/search-engines-indexation.en-us.md b/docs/content/doc/administration/search-engines-indexation.en-us.md
index 8c7f79d4b8..27427531ce 100644
--- a/docs/content/doc/administration/search-engines-indexation.en-us.md
+++ b/docs/content/doc/administration/search-engines-indexation.en-us.md
@@ -5,6 +5,8 @@ slug: "search-engines-indexation"
weight: 60
toc: false
draft: false
+aliases:
+ - /en-us/search-engines-indexation
menu:
sidebar:
parent: "administration"
diff --git a/docs/content/doc/administration/signing.en-us.md b/docs/content/doc/administration/signing.en-us.md
index 34580ab428..de539e34b2 100644
--- a/docs/content/doc/administration/signing.en-us.md
+++ b/docs/content/doc/administration/signing.en-us.md
@@ -5,6 +5,8 @@ slug: "signing"
weight: 50
toc: false
draft: false
+aliases:
+ - /en-us/signing
menu:
sidebar:
parent: "administration"