aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/development
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/development
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/development')
-rw-r--r--docs/content/doc/development/_index.en-us.md0
-rw-r--r--docs/content/doc/development/_index.zh-cn.md0
-rw-r--r--docs/content/doc/development/_index.zh-tw.md0
-rw-r--r--docs/content/doc/development/api-usage.en-us.md2
-rw-r--r--docs/content/doc/development/api-usage.zh-cn.md2
-rw-r--r--docs/content/doc/development/hacking-on-gitea.en-us.md2
-rw-r--r--docs/content/doc/development/hacking-on-gitea.zh-cn.md2
-rw-r--r--docs/content/doc/development/integrations.en-us.md2
-rw-r--r--docs/content/doc/development/integrations.zh-tw.md2
-rw-r--r--docs/content/doc/development/migrations.en-us.md2
-rw-r--r--docs/content/doc/development/migrations.zh-tw.md2
-rw-r--r--docs/content/doc/development/oauth2-provider.en-us.md2
-rw-r--r--docs/content/doc/development/oauth2-provider.zh-cn.md2
-rw-r--r--docs/content/doc/development/oauth2-provider.zh-tw.md2
14 files changed, 22 insertions, 0 deletions
diff --git a/docs/content/doc/development/_index.en-us.md b/docs/content/doc/development/_index.en-us.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/development/_index.en-us.md
diff --git a/docs/content/doc/development/_index.zh-cn.md b/docs/content/doc/development/_index.zh-cn.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/development/_index.zh-cn.md
diff --git a/docs/content/doc/development/_index.zh-tw.md b/docs/content/doc/development/_index.zh-tw.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/development/_index.zh-tw.md
diff --git a/docs/content/doc/development/api-usage.en-us.md b/docs/content/doc/development/api-usage.en-us.md
index 641012607b..fe334827c3 100644
--- a/docs/content/doc/development/api-usage.en-us.md
+++ b/docs/content/doc/development/api-usage.en-us.md
@@ -5,6 +5,8 @@ slug: "api-usage"
weight: 40
toc: false
draft: false
+aliases:
+ - /en-us/api-usage
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/api-usage.zh-cn.md b/docs/content/doc/development/api-usage.zh-cn.md
index b0821039ff..ceb69b3f0e 100644
--- a/docs/content/doc/development/api-usage.zh-cn.md
+++ b/docs/content/doc/development/api-usage.zh-cn.md
@@ -5,6 +5,8 @@ slug: "api-usage"
weight: 40
toc: false
draft: false
+aliases:
+ - /zh-cn/api-usage
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/hacking-on-gitea.en-us.md b/docs/content/doc/development/hacking-on-gitea.en-us.md
index da38d238ac..8ac7fcc34c 100644
--- a/docs/content/doc/development/hacking-on-gitea.en-us.md
+++ b/docs/content/doc/development/hacking-on-gitea.en-us.md
@@ -5,6 +5,8 @@ slug: "hacking-on-gitea"
weight: 10
toc: false
draft: false
+aliases:
+ - /en-us/hacking-on-gitea
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/hacking-on-gitea.zh-cn.md b/docs/content/doc/development/hacking-on-gitea.zh-cn.md
index c63d0c4685..3a4078dfdb 100644
--- a/docs/content/doc/development/hacking-on-gitea.zh-cn.md
+++ b/docs/content/doc/development/hacking-on-gitea.zh-cn.md
@@ -5,6 +5,8 @@ slug: "hacking-on-gitea"
weight: 10
toc: false
draft: false
+aliases:
+ - /zh-cn/hacking-on-gitea
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/integrations.en-us.md b/docs/content/doc/development/integrations.en-us.md
index dae557c9b8..bbb50ae71d 100644
--- a/docs/content/doc/development/integrations.en-us.md
+++ b/docs/content/doc/development/integrations.en-us.md
@@ -5,6 +5,8 @@ slug: "integrations"
weight: 65
toc: false
draft: false
+aliases:
+ - /en-us/integrations
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/integrations.zh-tw.md b/docs/content/doc/development/integrations.zh-tw.md
index fdc2103990..278a8f41d5 100644
--- a/docs/content/doc/development/integrations.zh-tw.md
+++ b/docs/content/doc/development/integrations.zh-tw.md
@@ -5,6 +5,8 @@ slug: "integrations"
weight: 65
toc: false
draft: false
+aliases:
+ - /zh-tw/integrations
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/migrations.en-us.md b/docs/content/doc/development/migrations.en-us.md
index 1d9103254b..f411634156 100644
--- a/docs/content/doc/development/migrations.en-us.md
+++ b/docs/content/doc/development/migrations.en-us.md
@@ -5,6 +5,8 @@ slug: "migrations-interfaces"
weight: 55
toc: false
draft: false
+aliases:
+ - /en-us/migrations-interfaces
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/migrations.zh-tw.md b/docs/content/doc/development/migrations.zh-tw.md
index bf995598f5..de4ddd788d 100644
--- a/docs/content/doc/development/migrations.zh-tw.md
+++ b/docs/content/doc/development/migrations.zh-tw.md
@@ -5,6 +5,8 @@ slug: "migrations-interfaces"
weight: 55
toc: false
draft: false
+aliases:
+ - /zh-tw/migrations-interfaces
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/oauth2-provider.en-us.md b/docs/content/doc/development/oauth2-provider.en-us.md
index 7be7a42934..b279e97a6e 100644
--- a/docs/content/doc/development/oauth2-provider.en-us.md
+++ b/docs/content/doc/development/oauth2-provider.en-us.md
@@ -5,6 +5,8 @@ slug: "oauth2-provider"
weight: 41
toc: false
draft: false
+aliases:
+ - /en-us/oauth2-provider
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/oauth2-provider.zh-cn.md b/docs/content/doc/development/oauth2-provider.zh-cn.md
index 926500d64f..3fbf174efc 100644
--- a/docs/content/doc/development/oauth2-provider.zh-cn.md
+++ b/docs/content/doc/development/oauth2-provider.zh-cn.md
@@ -5,6 +5,8 @@ slug: "oauth2-provider"
weight: 41
toc: false
draft: false
+aliases:
+ - /zh-cn/oauth2-provider
menu:
sidebar:
parent: "development"
diff --git a/docs/content/doc/development/oauth2-provider.zh-tw.md b/docs/content/doc/development/oauth2-provider.zh-tw.md
index b28e48d61e..8d62264abc 100644
--- a/docs/content/doc/development/oauth2-provider.zh-tw.md
+++ b/docs/content/doc/development/oauth2-provider.zh-tw.md
@@ -5,6 +5,8 @@ slug: "oauth2-provider"
weight: 41
toc: false
draft: false
+aliases:
+ - /zh-tw/oauth2-provider
menu:
sidebar:
parent: "development"