1
1
mirror of https://github.com/go-gitea/gitea synced 2024-05-28 23:15:48 +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 <john.olheiser@gmail.com>
This commit is contained in:
John Olheiser 2023-04-27 22:33:41 -05:00 committed by GitHub
parent 83022013c8
commit bb25f85ce8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
155 changed files with 278 additions and 49 deletions

View File

@ -10,7 +10,7 @@ enableEmoji: true
permalinks:
post: /:year/:month/:title/
doc: /:slug/
doc: /:sections[1:]/:slug/
page: /:slug/
default: /:slug/

View File

@ -5,6 +5,8 @@ slug: adding-legal-pages
weight: 110
toc: false
draft: false
aliases:
- /en-us/adding-legal-pages
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "backup-and-restore"
weight: 11
toc: false
draft: false
aliases:
- /en-us/backup-and-restore
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "backup-and-restore"
weight: 11
toc: false
draft: false
aliases:
- /zh-cn/backup-and-restore
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "backup-and-restore"
weight: 11
toc: false
draft: false
aliases:
- /zh-tw/backup-and-restore
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "cmd-embedded"
weight: 20
toc: false
draft: false
aliases:
- /en-us/cmd-embedded
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "command-line"
weight: 1
toc: false
draft: false
aliases:
- /en-us/command-line
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "config-cheat-sheet"
weight: 30
toc: false
draft: false
aliases:
- /en-us/config-cheat-sheet
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "config-cheat-sheet"
weight: 30
toc: false
draft: false
aliases:
- /zh-cn/config-cheat-sheet
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "customizing-gitea"
weight: 100
toc: false
draft: false
aliases:
- /en-us/customizing-gitea
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "customizing-gitea"
weight: 100
toc: false
draft: false
aliases:
- /zh-cn/customizing-gitea
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "email-setup"
weight: 12
toc: false
draft: false
aliases:
- /en-us/email-setup
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "environment-variables"
weight: 10
toc: false
draft: false
aliases:
- /en-us/environment-variables
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "environment-variables"
weight: 10
toc: false
draft: false
aliases:
- /zh-cn/environment-variables
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "external-renderers"
weight: 60
toc: false
draft: false
aliases:
- /en-us/external-renderers
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "fail2ban-setup"
weight: 16
toc: false
draft: false
aliases:
- /en-us/fail2ban-setup
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "fail2ban-setup"
weight: 16
toc: false
draft: false
aliases:
- /zh-cn/fail2ban-setup
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "git-lfs-setup"
weight: 12
toc: false
draft: false
aliases:
- /en-us/git-lfs-setup
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "https-setup"
weight: 12
toc: false
draft: false
aliases:
- /en-us/https-setup
menu:
sidebar:
parent: "administration"

View File

@ -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

View File

@ -5,6 +5,8 @@ slug: "mail-templates"
weight: 45
toc: false
draft: false
aliases:
- /en-us/mail-templates
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "repo-indexer"
weight: 45
toc: false
draft: false
aliases:
- /en-us/repo-indexer
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "reverse-proxies"
weight: 16
toc: false
draft: false
aliases:
- /en-us/reverse-proxies
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "reverse-proxies"
weight: 16
toc: false
draft: false
aliases:
- /zh-cn/reverse-proxies
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "search-engines-indexation"
weight: 60
toc: false
draft: false
aliases:
- /en-us/search-engines-indexation
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "signing"
weight: 50
toc: false
draft: false
aliases:
- /en-us/signing
menu:
sidebar:
parent: "administration"

View File

@ -5,6 +5,8 @@ slug: "guidelines-backend"
weight: 20
toc: false
draft: false
aliases:
- /en-us/guidelines-backend
menu:
sidebar:
parent: "contributing"

View File

@ -5,6 +5,8 @@ slug: "guidelines-frontend"
weight: 20
toc: false
draft: false
aliases:
- /en-us/guidelines-frontend
menu:
sidebar:
parent: "contributing"

View File

@ -5,6 +5,8 @@ slug: "guidelines-refactoring"
weight: 20
toc: false
draft: false
aliases:
- /en-us/guidelines-refactoring
menu:
sidebar:
parent: "contributing"

View File

@ -5,6 +5,8 @@ slug: "localization"
weight: 10
toc: false
draft: false
aliases:
- /en-us/localization
menu:
sidebar:
parent: "contributing"

View File

@ -5,6 +5,8 @@ slug: "localization"
weight: 20
toc: false
draft: false
aliases:
- /zh-cn/localization
menu:
sidebar:
parent: "contributing"

View File

@ -5,6 +5,8 @@ slug: "localization"
weight: 20
toc: false
draft: false
aliases:
- /zh-tw/localization
menu:
sidebar:
parent: "contributing"

View File

@ -5,6 +5,8 @@ slug: "api-usage"
weight: 40
toc: false
draft: false
aliases:
- /en-us/api-usage
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "api-usage"
weight: 40
toc: false
draft: false
aliases:
- /zh-cn/api-usage
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "hacking-on-gitea"
weight: 10
toc: false
draft: false
aliases:
- /en-us/hacking-on-gitea
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "hacking-on-gitea"
weight: 10
toc: false
draft: false
aliases:
- /zh-cn/hacking-on-gitea
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "integrations"
weight: 65
toc: false
draft: false
aliases:
- /en-us/integrations
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "integrations"
weight: 65
toc: false
draft: false
aliases:
- /zh-tw/integrations
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "migrations-interfaces"
weight: 55
toc: false
draft: false
aliases:
- /en-us/migrations-interfaces
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "migrations-interfaces"
weight: 55
toc: false
draft: false
aliases:
- /zh-tw/migrations-interfaces
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "oauth2-provider"
weight: 41
toc: false
draft: false
aliases:
- /en-us/oauth2-provider
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "oauth2-provider"
weight: 41
toc: false
draft: false
aliases:
- /zh-cn/oauth2-provider
menu:
sidebar:
parent: "development"

View File

@ -5,6 +5,8 @@ slug: "oauth2-provider"
weight: 41
toc: false
draft: false
aliases:
- /zh-tw/oauth2-provider
menu:
sidebar:
parent: "development"

View File

View File

View File

View File

@ -5,6 +5,8 @@ slug: "faq"
weight: 5
toc: false
draft: false
aliases:
- /en-us/faq
menu:
sidebar:
parent: "help"
@ -17,7 +19,7 @@ menu:
This page contains some common questions and answers.
For more help resources, check all [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}}).
For more help resources, check all [Support Options]({{< relref "doc/help/support.en-us.md" >}}).
**Table of Contents**
@ -408,7 +410,7 @@ Stdout on systemd goes to the journal by default. Try using `journalctl`, `journ
Similarly, stdout on docker can be viewed using `docker logs <container>`.
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" >}}).
## Initial logging

View File

@ -1,16 +1,18 @@
---
date: "2018-05-21T15:00:00+00:00"
title: "Support Options"
slug: "seek-help"
slug: "support"
weight: 20
toc: false
draft: false
aliases:
- /en-us/seek-help
menu:
sidebar:
parent: "help"
name: "Support Options"
weight: 20
identifier: "seek-help"
identifier: "support"
---
# Support Options

View File

@ -1,16 +1,18 @@
---
date: "2017-01-20T15:00:00+08:00"
title: "需要帮助"
slug: "seek-help"
slug: "support"
weight: 20
toc: false
draft: false
aliases:
- /zh-cn/seek-help
menu:
sidebar:
parent: "help"
name: "需要帮助"
weight: 20
identifier: "seek-help"
identifier: "support"
---
## 需要帮助?

View File

@ -1,16 +1,18 @@
---
date: "2018-05-21T15:00:00+00:00"
title: "取得協助"
slug: "seek-help"
slug: "support"
weight: 20
toc: false
draft: false
aliases:
- /zh-tw/seek-help
menu:
sidebar:
parent: "help"
name: "取得協助"
weight: 20
identifier: "seek-help"
identifier: "support"
---
# 取得協助

View File

@ -5,6 +5,8 @@ slug: "comparison"
weight: 5
toc: false
draft: false
aliases:
- /en-us/comparison
menu:
sidebar:
name: "Comparison"

View File

@ -5,6 +5,8 @@ slug: "comparison"
weight: 5
toc: false
draft: false
aliases:
- /zh-cn/comparison
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "comparison"
weight: 5
toc: false
draft: false
aliases:
- /zh-tw/comparison
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "database-prep"
weight: 10
toc: false
draft: false
aliases:
- /en-us/database-prep
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-from-binary"
weight: 15
toc: false
draft: false
aliases:
- /en-us/install-from-binary
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-from-binary"
weight: 15
toc: false
draft: false
aliases:
- /fr-fr/install-from-binary
menu:
sidebar:
parent: "installation"

View File

@ -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" >}})

View File

@ -5,6 +5,8 @@ slug: "install-from-binary"
weight: 15
toc: false
draft: false
aliases:
- /zh-tw/install-from-binary
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-from-package"
weight: 20
toc: false
draft: false
aliases:
- /en-us/install-from-package
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-from-package"
weight: 20
toc: false
draft: false
aliases:
- /fr-fr/install-from-package
menu:
sidebar:
parent: "installation"

View File

@ -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" >}})

View File

@ -5,6 +5,8 @@ slug: "install-from-package"
weight: 20
toc: false
draft: false
aliases:
- /zh-tw/install-from-package
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-from-source"
weight: 30
toc: false
draft: false
aliases:
- /en-us/install-from-source
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-from-source"
weight: 30
toc: false
draft: false
aliases:
- /fr-fr/install-from-source
menu:
sidebar:
parent: "installation"

View File

@ -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" >}})

View File

@ -5,6 +5,8 @@ slug: "install-from-source"
weight: 30
toc: false
draft: false
aliases:
- /zh-tw/install-from-source
menu:
sidebar:
parent: "installation"

View File

@ -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"

View File

@ -5,6 +5,8 @@ slug: "install-on-kubernetes"
weight: 80
toc: false
draft: false
aliases:
- /en-us/install-on-kubernetes
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-on-kubernetes"
weight: 80
toc: false
draft: false
aliases:
- /zh-cn/install-on-kubernetes
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-on-kubernetes"
weight: 80
toc: false
draft: false
aliases:
- /zh-tw/install-on-kubernetes
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "linux-service"
weight: 40
toc: false
draft: false
aliases:
- /en-us/linux-service
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "linux-service"
weight: 40
toc: false
draft: false
aliases:
- /zh-cn/linux-service
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "linux-service"
weight: 40
toc: false
draft: false
aliases:
- /zh-tw/linux-service
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "upgrade-from-gitea"
weight: 100
toc: false
draft: false
aliases:
- /en-us/upgrade-from-gitea
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "upgrade-from-gogs"
weight: 101
toc: false
draft: false
aliases:
- /en-us/upgrade-from-gogs
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "upgrade-from-gogs"
weight: 101
toc: false
draft: false
aliases:
- /fr-fr/upgrade-from-gogs
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "upgrade-from-gogs"
weight: 101
toc: false
draft: false
aliases:
- /zh-cn/upgrade-from-gogs
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "upgrade-from-gogs"
weight: 101
toc: false
draft: false
aliases:
- /zh-tw/upgrade-from-gogs
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "windows-service"
weight: 50
toc: false
draft: false
aliases:
- /en-us/windows-service
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "windows-service"
weight: 50
toc: false
draft: false
aliases:
- /fr-fr/windows-service
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "windows-service"
weight: 50
toc: false
draft: false
aliases:
- /zh-cn/windows-service
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "windows-service"
weight: 50
toc: false
draft: false
aliases:
- /zh-tw/windows-service
menu:
sidebar:
parent: "installation"

View File

@ -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"

View File

@ -5,6 +5,8 @@ slug: "install-with-docker"
weight: 70
toc: false
draft: false
aliases:
- /en-us/install-with-docker
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-with-docker"
weight: 70
toc: false
draft: false
aliases:
- /fr-fr/install-with-docker
menu:
sidebar:
parent: "installation"

View File

@ -5,6 +5,8 @@ slug: "install-with-docker"
weight: 70
toc: false
draft: false
aliases:
- /zh-cn/install-with-docker
menu:
sidebar:
parent: "installation"

Some files were not shown because too many files have changed in this diff Show More