Skip to content

Commit bb25f85

Browse files
authored
Refactor docs (#23752)
This was intended to be a small followup for #23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see #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>
1 parent 8302201 commit bb25f85

File tree

155 files changed

+278
-49
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+278
-49
lines changed

docs/config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ enableEmoji: true
1010

1111
permalinks:
1212
post: /:year/:month/:title/
13-
doc: /:slug/
13+
doc: /:sections[1:]/:slug/
1414
page: /:slug/
1515
default: /:slug/
1616

docs/content/doc/administration/_index.en-us.md

docs/content/doc/administration/_index.zh-cn.md

docs/content/doc/administration/_index.zh-tw.md

docs/content/doc/administration/adding-legal-pages.en-us.md

+2

docs/content/doc/administration/backup-and-restore.en-us.md

+2

docs/content/doc/administration/backup-and-restore.zh-cn.md

+2

docs/content/doc/administration/backup-and-restore.zh-tw.md

+2

docs/content/doc/administration/cmd-embedded.en-us.md

+2

docs/content/doc/administration/command-line.en-us.md

+2

docs/content/doc/administration/config-cheat-sheet.en-us.md

+2

docs/content/doc/administration/config-cheat-sheet.zh-cn.md

+2

docs/content/doc/administration/customizing-gitea.en-us.md

+2

docs/content/doc/administration/customizing-gitea.zh-cn.md

+2

docs/content/doc/administration/email-setup.en-us.md

+2

docs/content/doc/administration/environment-variables.en-us.md

+2

docs/content/doc/administration/environment-variables.zh-cn.md

+2

docs/content/doc/administration/external-renderers.en-us.md

+2

docs/content/doc/administration/fail2ban-setup.en-us.md

+2

docs/content/doc/administration/fail2ban-setup.zh-cn.md

+2

docs/content/doc/administration/git-lfs-support.en-us.md

+2

docs/content/doc/administration/https-support.en-us.md

+2

docs/content/doc/administration/logging-documentation.en-us.md

+3-1

docs/content/doc/administration/mail-templates.en-us.md

+2

docs/content/doc/administration/repo-indexer.en-us.md

+2

docs/content/doc/administration/reverse-proxies.en-us.md

+2

docs/content/doc/administration/reverse-proxies.zh-cn.md

+2

docs/content/doc/administration/search-engines-indexation.en-us.md

+2

docs/content/doc/administration/signing.en-us.md

+2

docs/content/doc/contributing/_index.de-de.md

docs/content/doc/contributing/_index.en-us.md

docs/content/doc/contributing/_index.zh-cn.md

docs/content/doc/contributing/_index.zh-tw.md

docs/content/doc/contributing/guidelines-backend.en-us.md

+2

docs/content/doc/contributing/guidelines-frontend.en-us.md

+2

docs/content/doc/contributing/guidelines-refactoring.en-us.md

+2

docs/content/doc/contributing/localization.en-us.md

+2

docs/content/doc/contributing/localization.zh-cn.md

+2

docs/content/doc/contributing/localization.zh-tw.md

+2

docs/content/doc/development/_index.en-us.md

docs/content/doc/development/_index.zh-cn.md

docs/content/doc/development/_index.zh-tw.md

docs/content/doc/development/api-usage.en-us.md

+2

docs/content/doc/development/api-usage.zh-cn.md

+2

docs/content/doc/development/hacking-on-gitea.en-us.md

+2

docs/content/doc/development/hacking-on-gitea.zh-cn.md

+2

docs/content/doc/development/integrations.en-us.md

+2

docs/content/doc/development/integrations.zh-tw.md

+2

docs/content/doc/development/migrations.en-us.md

+2

docs/content/doc/development/migrations.zh-tw.md

+2

docs/content/doc/development/oauth2-provider.en-us.md

+2

docs/content/doc/development/oauth2-provider.zh-cn.md

+2

docs/content/doc/development/oauth2-provider.zh-tw.md

+2

docs/content/doc/help/_index.en-us.md

docs/content/doc/help/_index.zh-cn.md

docs/content/doc/help/_index.zh-tw.md

0 commit comments

Comments
 (0)