aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/help
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/help
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/help')
-rw-r--r--docs/content/doc/help/_index.en-us.md0
-rw-r--r--docs/content/doc/help/_index.zh-cn.md0
-rw-r--r--docs/content/doc/help/_index.zh-tw.md0
-rw-r--r--docs/content/doc/help/faq.en-us.md6
-rw-r--r--docs/content/doc/help/search.de-de.md18
-rw-r--r--docs/content/doc/help/search.en-us.md18
-rw-r--r--docs/content/doc/help/search.fr-fr.md18
-rw-r--r--docs/content/doc/help/search.nl-nl.md18
-rw-r--r--docs/content/doc/help/search.pt-br.md18
-rw-r--r--docs/content/doc/help/search.zh-cn.md18
-rw-r--r--docs/content/doc/help/search.zh-tw.md18
-rw-r--r--docs/content/doc/help/support.en-us.md (renamed from docs/content/doc/help/seek-help.en-us.md)6
-rw-r--r--docs/content/doc/help/support.zh-cn.md (renamed from docs/content/doc/help/seek-help.zh-cn.md)6
-rw-r--r--docs/content/doc/help/support.zh-tw.md (renamed from docs/content/doc/help/seek-help.zh-tw.md)6
14 files changed, 16 insertions, 134 deletions
diff --git a/docs/content/doc/help/_index.en-us.md b/docs/content/doc/help/_index.en-us.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/help/_index.en-us.md
diff --git a/docs/content/doc/help/_index.zh-cn.md b/docs/content/doc/help/_index.zh-cn.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/help/_index.zh-cn.md
diff --git a/docs/content/doc/help/_index.zh-tw.md b/docs/content/doc/help/_index.zh-tw.md
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/docs/content/doc/help/_index.zh-tw.md
diff --git a/docs/content/doc/help/faq.en-us.md b/docs/content/doc/help/faq.en-us.md
index 4847e8e03b..53215e18a5 100644
--- a/docs/content/doc/help/faq.en-us.md
+++ b/docs/content/doc/help/faq.en-us.md
@@ -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
diff --git a/docs/content/doc/help/search.de-de.md b/docs/content/doc/help/search.de-de.md
deleted file mode 100644
index d22e9c1b2e..0000000000
--- a/docs/content/doc/help/search.de-de.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "Search"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/search.en-us.md b/docs/content/doc/help/search.en-us.md
deleted file mode 100644
index d22e9c1b2e..0000000000
--- a/docs/content/doc/help/search.en-us.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "Search"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/search.fr-fr.md b/docs/content/doc/help/search.fr-fr.md
deleted file mode 100644
index 421f7830b2..0000000000
--- a/docs/content/doc/help/search.fr-fr.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "Chercher"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/search.nl-nl.md b/docs/content/doc/help/search.nl-nl.md
deleted file mode 100644
index d22e9c1b2e..0000000000
--- a/docs/content/doc/help/search.nl-nl.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "Search"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/search.pt-br.md b/docs/content/doc/help/search.pt-br.md
deleted file mode 100644
index d22e9c1b2e..0000000000
--- a/docs/content/doc/help/search.pt-br.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "Search"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/search.zh-cn.md b/docs/content/doc/help/search.zh-cn.md
deleted file mode 100644
index 778df0d47d..0000000000
--- a/docs/content/doc/help/search.zh-cn.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "搜索"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/search.zh-tw.md b/docs/content/doc/help/search.zh-tw.md
deleted file mode 100644
index 8f2ce17ec6..0000000000
--- a/docs/content/doc/help/search.zh-tw.md
+++ /dev/null
@@ -1,18 +0,0 @@
----
-date: "2019-11-12T16:00:00+02:00"
-title: "搜尋"
-slug: "search"
-weight: 1
-toc: false
-draft: false
-sitemap:
- priority : 1
-layout: "search"
----
-
-
-This file exists solely to respond to /search URL with the related `search` layout template.
-
-No content shown here is rendered, all content is based in the template layouts/doc/search.html
-
-Setting a very low sitemap priority will tell search engines this is not important content.
diff --git a/docs/content/doc/help/seek-help.en-us.md b/docs/content/doc/help/support.en-us.md
index 0e56b9a575..c6db3d6eb3 100644
--- a/docs/content/doc/help/seek-help.en-us.md
+++ b/docs/content/doc/help/support.en-us.md
@@ -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
diff --git a/docs/content/doc/help/seek-help.zh-cn.md b/docs/content/doc/help/support.zh-cn.md
index 80febad248..775dfe83bd 100644
--- a/docs/content/doc/help/seek-help.zh-cn.md
+++ b/docs/content/doc/help/support.zh-cn.md
@@ -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"
---
## 需要帮助?
diff --git a/docs/content/doc/help/seek-help.zh-tw.md b/docs/content/doc/help/support.zh-tw.md
index f87dad547a..a9c35eaafb 100644
--- a/docs/content/doc/help/seek-help.zh-tw.md
+++ b/docs/content/doc/help/support.zh-tw.md
@@ -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"
---
# 取得協助