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/installation | |
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/installation')
41 files changed, 77 insertions, 3 deletions
diff --git a/docs/content/doc/installation/_index.en-us.md b/docs/content/doc/installation/_index.en-us.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/installation/_index.en-us.md diff --git a/docs/content/doc/installation/_index.fr-fr.md b/docs/content/doc/installation/_index.fr-fr.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/installation/_index.fr-fr.md diff --git a/docs/content/doc/installation/_index.zh-cn.md b/docs/content/doc/installation/_index.zh-cn.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/installation/_index.zh-cn.md diff --git a/docs/content/doc/installation/_index.zh-tw.md b/docs/content/doc/installation/_index.zh-tw.md new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/docs/content/doc/installation/_index.zh-tw.md diff --git a/docs/content/doc/installation/comparison.en-us.md b/docs/content/doc/installation/comparison.en-us.md index 082b2a85ed..578b00c211 100644 --- a/docs/content/doc/installation/comparison.en-us.md +++ b/docs/content/doc/installation/comparison.en-us.md @@ -5,6 +5,8 @@ slug: "comparison" weight: 5 toc: false draft: false +aliases: + - /en-us/comparison menu: sidebar: name: "Comparison" diff --git a/docs/content/doc/installation/comparison.zh-cn.md b/docs/content/doc/installation/comparison.zh-cn.md index 7dfca526eb..06c770caa2 100644 --- a/docs/content/doc/installation/comparison.zh-cn.md +++ b/docs/content/doc/installation/comparison.zh-cn.md @@ -5,6 +5,8 @@ slug: "comparison" weight: 5 toc: false draft: false +aliases: + - /zh-cn/comparison menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/comparison.zh-tw.md b/docs/content/doc/installation/comparison.zh-tw.md index 8919052343..042acba8d3 100644 --- a/docs/content/doc/installation/comparison.zh-tw.md +++ b/docs/content/doc/installation/comparison.zh-tw.md @@ -5,6 +5,8 @@ slug: "comparison" weight: 5 toc: false draft: false +aliases: + - /zh-tw/comparison menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/database-preparation.en-us.md b/docs/content/doc/installation/database-preparation.en-us.md index edad89b07c..4b0d1b5ba8 100644 --- a/docs/content/doc/installation/database-preparation.en-us.md +++ b/docs/content/doc/installation/database-preparation.en-us.md @@ -5,6 +5,8 @@ slug: "database-prep" weight: 10 toc: false draft: false +aliases: + - /en-us/database-prep menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-binary.en-us.md b/docs/content/doc/installation/from-binary.en-us.md index ce1d7e5a2c..c7824c3480 100644 --- a/docs/content/doc/installation/from-binary.en-us.md +++ b/docs/content/doc/installation/from-binary.en-us.md @@ -5,6 +5,8 @@ slug: "install-from-binary" weight: 15 toc: false draft: false +aliases: + - /en-us/install-from-binary menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-binary.fr-fr.md b/docs/content/doc/installation/from-binary.fr-fr.md index 7dfbe7dd5f..eea3819384 100644 --- a/docs/content/doc/installation/from-binary.fr-fr.md +++ b/docs/content/doc/installation/from-binary.fr-fr.md @@ -5,6 +5,8 @@ slug: "install-from-binary" weight: 15 toc: false draft: false +aliases: + - /fr-fr/install-from-binary menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-binary.zh-cn.md b/docs/content/doc/installation/from-binary.zh-cn.md index 55cf6c1da2..abe799dc94 100644 --- a/docs/content/doc/installation/from-binary.zh-cn.md +++ b/docs/content/doc/installation/from-binary.zh-cn.md @@ -5,6 +5,8 @@ slug: "install-from-binary" weight: 15 toc: false draft: false +aliases: + - /zh-cn/install-from-binary menu: sidebar: parent: "installation" @@ -161,4 +163,4 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini > 更多经验总结,请参考英文版 [Troubleshooting](/en-us/install-from-binary/#troubleshooting) -如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "seek-help.zh-cn.md" >}}) +如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "support.zh-cn.md" >}}) diff --git a/docs/content/doc/installation/from-binary.zh-tw.md b/docs/content/doc/installation/from-binary.zh-tw.md index 3991b101ae..858cee2193 100644 --- a/docs/content/doc/installation/from-binary.zh-tw.md +++ b/docs/content/doc/installation/from-binary.zh-tw.md @@ -5,6 +5,8 @@ slug: "install-from-binary" weight: 15 toc: false draft: false +aliases: + - /zh-tw/install-from-binary menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-package.en-us.md b/docs/content/doc/installation/from-package.en-us.md index 2615b7d27d..15283d5837 100644 --- a/docs/content/doc/installation/from-package.en-us.md +++ b/docs/content/doc/installation/from-package.en-us.md @@ -5,6 +5,8 @@ slug: "install-from-package" weight: 20 toc: false draft: false +aliases: + - /en-us/install-from-package menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-package.fr-fr.md b/docs/content/doc/installation/from-package.fr-fr.md index eff74c31e5..b7e842400d 100644 --- a/docs/content/doc/installation/from-package.fr-fr.md +++ b/docs/content/doc/installation/from-package.fr-fr.md @@ -5,6 +5,8 @@ slug: "install-from-package" weight: 20 toc: false draft: false +aliases: + - /fr-fr/install-from-package menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-package.zh-cn.md b/docs/content/doc/installation/from-package.zh-cn.md index e3ed3aa371..a8e92694f9 100644 --- a/docs/content/doc/installation/from-package.zh-cn.md +++ b/docs/content/doc/installation/from-package.zh-cn.md @@ -5,6 +5,8 @@ slug: "install-from-package" weight: 20 toc: false draft: false +aliases: + - /zh-cn/install-from-package menu: sidebar: parent: "installation" @@ -107,4 +109,4 @@ make install clean ## 需要帮助? -如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "seek-help.zh-cn.md" >}}) +如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "support.zh-cn.md" >}}) diff --git a/docs/content/doc/installation/from-package.zh-tw.md b/docs/content/doc/installation/from-package.zh-tw.md index 1616ba6655..c5347991ec 100644 --- a/docs/content/doc/installation/from-package.zh-tw.md +++ b/docs/content/doc/installation/from-package.zh-tw.md @@ -5,6 +5,8 @@ slug: "install-from-package" weight: 20 toc: false draft: false +aliases: + - /zh-tw/install-from-package menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-source.en-us.md b/docs/content/doc/installation/from-source.en-us.md index 45064a43a8..72a3e12472 100644 --- a/docs/content/doc/installation/from-source.en-us.md +++ b/docs/content/doc/installation/from-source.en-us.md @@ -5,6 +5,8 @@ slug: "install-from-source" weight: 30 toc: false draft: false +aliases: + - /en-us/install-from-source menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-source.fr-fr.md b/docs/content/doc/installation/from-source.fr-fr.md index ebb0941754..544059b573 100644 --- a/docs/content/doc/installation/from-source.fr-fr.md +++ b/docs/content/doc/installation/from-source.fr-fr.md @@ -5,6 +5,8 @@ slug: "install-from-source" weight: 30 toc: false draft: false +aliases: + - /fr-fr/install-from-source menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/from-source.zh-cn.md b/docs/content/doc/installation/from-source.zh-cn.md index 9d5c50cbda..8f3ccbe7e2 100644 --- a/docs/content/doc/installation/from-source.zh-cn.md +++ b/docs/content/doc/installation/from-source.zh-cn.md @@ -5,6 +5,8 @@ slug: "install-from-source" weight: 30 toc: false draft: false +aliases: + - /zh-cn/install-from-source menu: sidebar: parent: "installation" @@ -104,4 +106,4 @@ CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sq ## 需要帮助? -如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "seek-help.zh-cn.md" >}}) +如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "support.zh-cn.md" >}}) diff --git a/docs/content/doc/installation/from-source.zh-tw.md b/docs/content/doc/installation/from-source.zh-tw.md index fc9c2dca4c..f9e6e06eff 100644 --- a/docs/content/doc/installation/from-source.zh-tw.md +++ b/docs/content/doc/installation/from-source.zh-tw.md @@ -5,6 +5,8 @@ slug: "install-from-source" weight: 30 toc: false draft: false +aliases: + - /zh-tw/install-from-source menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/on-cloud-provider.en-us.md b/docs/content/doc/installation/on-cloud-provider.en-us.md index 550ef3f677..20ca812eff 100644 --- a/docs/content/doc/installation/on-cloud-provider.en-us.md +++ b/docs/content/doc/installation/on-cloud-provider.en-us.md @@ -5,6 +5,8 @@ slug: "install-on-cloud-provider" weight: 90 toc: false draft: false +aliases: + - /en-us/install-on-cloud-provider menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/on-kubernetes.en-us.md b/docs/content/doc/installation/on-kubernetes.en-us.md index e8f3612ea4..b46a61df02 100644 --- a/docs/content/doc/installation/on-kubernetes.en-us.md +++ b/docs/content/doc/installation/on-kubernetes.en-us.md @@ -5,6 +5,8 @@ slug: "install-on-kubernetes" weight: 80 toc: false draft: false +aliases: + - /en-us/install-on-kubernetes menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/on-kubernetes.zh-cn.md b/docs/content/doc/installation/on-kubernetes.zh-cn.md index 91dec2e73a..367aef1cf3 100644 --- a/docs/content/doc/installation/on-kubernetes.zh-cn.md +++ b/docs/content/doc/installation/on-kubernetes.zh-cn.md @@ -5,6 +5,8 @@ slug: "install-on-kubernetes" weight: 80 toc: false draft: false +aliases: + - /zh-cn/install-on-kubernetes menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/on-kubernetes.zh-tw.md b/docs/content/doc/installation/on-kubernetes.zh-tw.md index 6d31a14b05..51446911d5 100644 --- a/docs/content/doc/installation/on-kubernetes.zh-tw.md +++ b/docs/content/doc/installation/on-kubernetes.zh-tw.md @@ -5,6 +5,8 @@ slug: "install-on-kubernetes" weight: 80 toc: false draft: false +aliases: + - /zh-tw/install-on-kubernetes menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/run-as-service-in-ubuntu.en-us.md b/docs/content/doc/installation/run-as-service-in-ubuntu.en-us.md index 19b3be1a22..3587dfc01a 100644 --- a/docs/content/doc/installation/run-as-service-in-ubuntu.en-us.md +++ b/docs/content/doc/installation/run-as-service-in-ubuntu.en-us.md @@ -5,6 +5,8 @@ slug: "linux-service" weight: 40 toc: false draft: false +aliases: + - /en-us/linux-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/run-as-service-in-ubuntu.zh-cn.md b/docs/content/doc/installation/run-as-service-in-ubuntu.zh-cn.md index aa00a42aa6..62312c060c 100644 --- a/docs/content/doc/installation/run-as-service-in-ubuntu.zh-cn.md +++ b/docs/content/doc/installation/run-as-service-in-ubuntu.zh-cn.md @@ -5,6 +5,8 @@ slug: "linux-service" weight: 40 toc: false draft: false +aliases: + - /zh-cn/linux-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/run-as-service-in-ubuntu.zh-tw.md b/docs/content/doc/installation/run-as-service-in-ubuntu.zh-tw.md index de811d73e7..6b8a4cfce8 100644 --- a/docs/content/doc/installation/run-as-service-in-ubuntu.zh-tw.md +++ b/docs/content/doc/installation/run-as-service-in-ubuntu.zh-tw.md @@ -5,6 +5,8 @@ slug: "linux-service" weight: 40 toc: false draft: false +aliases: + - /zh-tw/linux-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/upgrade-from-gitea.en-us.md b/docs/content/doc/installation/upgrade-from-gitea.en-us.md index 8748573a2f..a6415f7861 100644 --- a/docs/content/doc/installation/upgrade-from-gitea.en-us.md +++ b/docs/content/doc/installation/upgrade-from-gitea.en-us.md @@ -5,6 +5,8 @@ slug: "upgrade-from-gitea" weight: 100 toc: false draft: false +aliases: + - /en-us/upgrade-from-gitea menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/upgrade-from-gogs.en-us.md b/docs/content/doc/installation/upgrade-from-gogs.en-us.md index 5b08ed2f6a..2e149c6a2b 100644 --- a/docs/content/doc/installation/upgrade-from-gogs.en-us.md +++ b/docs/content/doc/installation/upgrade-from-gogs.en-us.md @@ -5,6 +5,8 @@ slug: "upgrade-from-gogs" weight: 101 toc: false draft: false +aliases: + - /en-us/upgrade-from-gogs menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/upgrade-from-gogs.fr-fr.md b/docs/content/doc/installation/upgrade-from-gogs.fr-fr.md index 2ce1b4bf3d..9a46562f06 100644 --- a/docs/content/doc/installation/upgrade-from-gogs.fr-fr.md +++ b/docs/content/doc/installation/upgrade-from-gogs.fr-fr.md @@ -5,6 +5,8 @@ slug: "upgrade-from-gogs" weight: 101 toc: false draft: false +aliases: + - /fr-fr/upgrade-from-gogs menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/upgrade-from-gogs.zh-cn.md b/docs/content/doc/installation/upgrade-from-gogs.zh-cn.md index 048cfee793..f537896ca1 100644 --- a/docs/content/doc/installation/upgrade-from-gogs.zh-cn.md +++ b/docs/content/doc/installation/upgrade-from-gogs.zh-cn.md @@ -5,6 +5,8 @@ slug: "upgrade-from-gogs" weight: 101 toc: false draft: false +aliases: + - /zh-cn/upgrade-from-gogs menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/upgrade-from-gogs.zh-tw.md b/docs/content/doc/installation/upgrade-from-gogs.zh-tw.md index 0082bf73cb..9812efaf94 100644 --- a/docs/content/doc/installation/upgrade-from-gogs.zh-tw.md +++ b/docs/content/doc/installation/upgrade-from-gogs.zh-tw.md @@ -5,6 +5,8 @@ slug: "upgrade-from-gogs" weight: 101 toc: false draft: false +aliases: + - /zh-tw/upgrade-from-gogs menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/windows-service.en-us.md b/docs/content/doc/installation/windows-service.en-us.md index 6efc1fd582..d3f5a9abae 100644 --- a/docs/content/doc/installation/windows-service.en-us.md +++ b/docs/content/doc/installation/windows-service.en-us.md @@ -5,6 +5,8 @@ slug: "windows-service" weight: 50 toc: false draft: false +aliases: + - /en-us/windows-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/windows-service.fr-fr.md b/docs/content/doc/installation/windows-service.fr-fr.md index a0f8f057c0..c4e00b04e1 100644 --- a/docs/content/doc/installation/windows-service.fr-fr.md +++ b/docs/content/doc/installation/windows-service.fr-fr.md @@ -5,6 +5,8 @@ slug: "windows-service" weight: 50 toc: false draft: false +aliases: + - /fr-fr/windows-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/windows-service.zh-cn.md b/docs/content/doc/installation/windows-service.zh-cn.md index 8388a057b3..0f2a0f5869 100644 --- a/docs/content/doc/installation/windows-service.zh-cn.md +++ b/docs/content/doc/installation/windows-service.zh-cn.md @@ -5,6 +5,8 @@ slug: "windows-service" weight: 50 toc: false draft: false +aliases: + - /zh-cn/windows-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/windows-service.zh-tw.md b/docs/content/doc/installation/windows-service.zh-tw.md index a2934a52d1..5764d647fc 100644 --- a/docs/content/doc/installation/windows-service.zh-tw.md +++ b/docs/content/doc/installation/windows-service.zh-tw.md @@ -5,6 +5,8 @@ slug: "windows-service" weight: 50 toc: false draft: false +aliases: + - /zh-tw/windows-service menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/with-docker-rootless.en-us.md b/docs/content/doc/installation/with-docker-rootless.en-us.md index f33e99c580..e1073a1d67 100644 --- a/docs/content/doc/installation/with-docker-rootless.en-us.md +++ b/docs/content/doc/installation/with-docker-rootless.en-us.md @@ -5,6 +5,8 @@ slug: "install-with-docker-rootless" weight: 60 toc: false draft: false +aliases: + - /en-us/install-with-docker-rootless menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/with-docker.en-us.md b/docs/content/doc/installation/with-docker.en-us.md index 05764e0bc9..043a10c08f 100644 --- a/docs/content/doc/installation/with-docker.en-us.md +++ b/docs/content/doc/installation/with-docker.en-us.md @@ -5,6 +5,8 @@ slug: "install-with-docker" weight: 70 toc: false draft: false +aliases: + - /en-us/install-with-docker menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/with-docker.fr-fr.md b/docs/content/doc/installation/with-docker.fr-fr.md index 59f2b0752a..362aa5fc67 100644 --- a/docs/content/doc/installation/with-docker.fr-fr.md +++ b/docs/content/doc/installation/with-docker.fr-fr.md @@ -5,6 +5,8 @@ slug: "install-with-docker" weight: 70 toc: false draft: false +aliases: + - /fr-fr/install-with-docker menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/with-docker.zh-cn.md b/docs/content/doc/installation/with-docker.zh-cn.md index e5bb07b495..50acc3ffae 100644 --- a/docs/content/doc/installation/with-docker.zh-cn.md +++ b/docs/content/doc/installation/with-docker.zh-cn.md @@ -5,6 +5,8 @@ slug: "install-with-docker" weight: 70 toc: false draft: false +aliases: + - /zh-cn/install-with-docker menu: sidebar: parent: "installation" diff --git a/docs/content/doc/installation/with-docker.zh-tw.md b/docs/content/doc/installation/with-docker.zh-tw.md index e2e47e8702..fdf5a0101d 100644 --- a/docs/content/doc/installation/with-docker.zh-tw.md +++ b/docs/content/doc/installation/with-docker.zh-tw.md @@ -5,6 +5,8 @@ slug: "install-with-docker" weight: 70 toc: false draft: false +aliases: + - /zh-tw/install-with-docker menu: sidebar: parent: "installation" |