mirror of
https://github.com/go-gitea/gitea
synced 2025-07-22 18:28:37 +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
GitHub
0
docs/content/doc/help/_index.en-us.md
Normal file
0
docs/content/doc/help/_index.en-us.md
Normal file
0
docs/content/doc/help/_index.zh-cn.md
Normal file
0
docs/content/doc/help/_index.zh-cn.md
Normal file
0
docs/content/doc/help/_index.zh-tw.md
Normal file
0
docs/content/doc/help/_index.zh-tw.md
Normal 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
|
||||
|
||||
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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
|
||||
@@ -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"
|
||||
---
|
||||
|
||||
## 需要帮助?
|
||||
@@ -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"
|
||||
---
|
||||
|
||||
# 取得協助
|
||||
Reference in New Issue
Block a user