Skip to content

Commit 0018b0a

Browse files
authored
Unify doc links to use paths relative to doc folder (#24979)
Changes: 1. Use uniform links types relative to doc folder (start with `doc/`) 2. According to [docusaurus links](https://docusaurus.io/docs/markdown-features/links), if `<a>` is used, the `href` is resolved as URL location, but not file location. So need to use `[text]({{< relref "path" >}})` instead.
1 parent 79a4c80 commit 0018b0a

10 files changed

+21
-23
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,8 @@ to the Gitea sources. Otherwise, changes can't be pushed.
123123
## Building Gitea (Basic)
124124

125125
Take a look at our
126-
<a href='{{< relref "doc/installation/from-source.en-us.md" >}}'>instructions</a>
127-
for <a href='{{< relref "doc/installation/from-source.en-us.md" >}}'>building
128-
from source</a>.
126+
[instructions]({{< relref "doc/installation/from-source.en-us.md" >}})
127+
for [building from source]({{< relref "doc/installation/from-source.en-us.md" >}}).
129128

130129
The simplest recommended way to build from source is:
131130

@@ -266,7 +265,7 @@ OpenAPI 3 documentation.
266265
When creating new configuration options, it is not enough to add them to the
267266
`modules/setting` files. You should add information to `custom/conf/app.ini`
268267
and to the
269-
<a href='{{< relref "doc/administration/config-cheat-sheet.en-us.md" >}}'>configuration cheat sheet</a>
268+
[configuration cheat sheet]({{< relref "doc/administration/config-cheat-sheet.en-us.md" >}})
270269
found in `docs/content/doc/administer/config-cheat-sheet.en-us.md`
271270

272271
### Changing the logo

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ git fetch --all --prune
115115
## 构建 Gitea(基本)
116116

117117
看看我们的
118-
<a href='{{ < relref "doc/installation/from-source.en-us.md" > }}'>说明</a>
119-
关于如何 <a href='{{ < relref "doc/installation/from-source.en-us.md" > }}'>从源代码构建</a>
118+
[说明]({{< relref "doc/installation/from-source.zh-cn.md" >}})
119+
关于如何[从源代码构建]({{< relref "doc/installation/from-source.zh-cn.md" >}})
120120

121121
从源代码构建的最简单推荐方法是:
122122

@@ -249,7 +249,7 @@ make swagger-check
249249
### 创建新的配置选项
250250

251251
创建新的配置选项时,将它们添加到 `modules/setting` 的对应文件。您应该将信息添加到 `custom/conf/app.ini`
252-
并到 <a href = '{{ < relref "doc/administration/config-cheat-sheet.zh-cn.md" > }}'>配置备忘单</a>
252+
并到[配置备忘单]({{< relref "doc/administration/config-cheat-sheet.zh-cn.md" >}})
253253
`docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到
254254

255255
### 更改Logo

docs/content/doc/installation/from-binary.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Older Linux distributions (such as Debian 7 and CentOS 6) may not be able to loa
200200
Gitea binary, usually producing an error such as `./gitea: /lib/x86_64-linux-gnu/libc.so.6:
201201
version 'GLIBC\_2.14' not found (required by ./gitea)`. This is due to the integrated
202202
SQLite support in the binaries provided by dl.gitea.com. In this situation, it is usually
203-
possible to [install from source]({{< relref "from-source.en-us.md" >}}), without including
203+
possible to [install from source]({{< relref "doc/installation/from-source.en-us.md" >}}), without including
204204
SQLite support.
205205

206206
### Running Gitea on another port

docs/content/doc/installation/from-binary.fr-fr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Après avoir suivi les étapes ci-dessus, vous aurez un binaire `gitea` dans vot
3636

3737
### Anciennes version de glibc
3838

39-
Les anciennes distributions Linux (comme Debian 7 ou CentOS 6) peuvent ne pas être capable d'exécuter le binaire Gitea, résultant généralement une erreur du type ```./gitea: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.14' not found (required by ./gitea)```. Cette erreur est due au driver SQLite que nous intégrons dans le binaire Gitea. Dans le futur, nous fournirons des binaires sans la dépendance pour la bibliothèque glibc. En attendant, vous pouvez mettre à jour votre distribution ou installer Gitea depuis le [code source]({{< relref "from-source.fr-fr.md" >}}).
39+
Les anciennes distributions Linux (comme Debian 7 ou CentOS 6) peuvent ne pas être capable d'exécuter le binaire Gitea, résultant généralement une erreur du type ```./gitea: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.14' not found (required by ./gitea)```. Cette erreur est due au driver SQLite que nous intégrons dans le binaire Gitea. Dans le futur, nous fournirons des binaires sans la dépendance pour la bibliothèque glibc. En attendant, vous pouvez mettre à jour votre distribution ou installer Gitea depuis le [code source]({{< relref "doc/installation/from-source.fr-fr.md" >}}).
4040

4141
### Exécuter Gitea avec un autre port
4242

docs/content/doc/installation/from-binary.zh-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ cp gitea /usr/local/bin/gitea
143143

144144
### 1. 创建服务自动启动 Gitea(推荐)
145145

146-
学习创建 [Linux 服务]({{< relref "run-as-service-in-ubuntu.zh-cn.md" >}})
146+
学习创建 [Linux 服务]({{< relref "doc/installation/run-as-service-in-ubuntu.zh-cn.md" >}})
147147

148148
### 2. 通过命令行终端运行
149149

@@ -175,4 +175,4 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini
175175

176176
> 更多经验总结,请参考英文版 [Troubleshooting](/en-us/install-from-binary/#troubleshooting)
177177
178-
如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "support.zh-cn.md" >}})
178+
如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "doc/help/support.zh-cn.md" >}})

docs/content/doc/installation/from-package.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ menu:
2424
## macOS
2525

2626
Currently, the only supported method of installation on MacOS is [Homebrew](http://brew.sh/).
27-
Following the [deployment from binary]({{< relref "from-binary.en-us.md" >}}) guide may work,
27+
Following the [deployment from binary]({{< relref "doc/installation/from-binary.en-us.md" >}}) guide may work,
2828
but is not supported. To install Gitea via `brew`:
2929

3030
```
@@ -87,7 +87,7 @@ There is a [Gitea](https://chocolatey.org/packages/gitea) package for Windows by
8787
choco install gitea
8888
```
8989

90-
Or follow the [deployment from binary]({{< relref "from-binary.en-us.md" >}}) guide.
90+
Or follow the [deployment from binary]({{< relref "doc/installation/from-binary.en-us.md" >}}) guide.
9191

9292
## FreeBSD
9393

docs/content/doc/installation/from-package.fr-fr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ menu:
1919

2020
## Linux
2121

22-
Nous n'avons pas encore publié de paquet pour Linux, nous allons mettre à jour cette page directement lorsque nous commencerons à publier des paquets pour toutes distributions Linux. En attendant, vous devriez suivre les [instructions d'installation]({{< relref "from-binary.fr-fr.md" >}}) avec le binaire pré-compilé.
22+
Nous n'avons pas encore publié de paquet pour Linux, nous allons mettre à jour cette page directement lorsque nous commencerons à publier des paquets pour toutes distributions Linux. En attendant, vous devriez suivre les [instructions d'installation]({{< relref "doc/installation/from-binary.fr-fr.md" >}}) avec le binaire pré-compilé.
2323

2424
## Windows
2525

26-
Nous n'avons pas encore publié de paquet pour Windows, nous allons mettre à jour cette page directement lorsque nous commencerons à publier des paquets sous la forme de fichiers `MSI` ou via [Chocolatey](https://chocolatey.org/). En attendant, vous devriez suivre les [instructions d'installation]({{< relref "from-binary.fr-fr.md" >}}) avec le binaire pré-compilé.
26+
Nous n'avons pas encore publié de paquet pour Windows, nous allons mettre à jour cette page directement lorsque nous commencerons à publier des paquets sous la forme de fichiers `MSI` ou via [Chocolatey](https://chocolatey.org/). En attendant, vous devriez suivre les [instructions d'installation]({{< relref "doc/installation/from-binary.fr-fr.md" >}}) avec le binaire pré-compilé.
2727

2828
## macOS
2929

30-
Actuellement, nous ne supportons que l'installation via `brew` pour macOS. Si vous n'utilisez pas [Homebrew](http://brew.sh/), vous pouvez suivre les [instructions d'installation]({{< relref "from-binary.fr-fr.md" >}}) avec le binaire pré-compilé. Pour installer Gitea depuis `brew`, utilisez les commandes suivantes :
30+
Actuellement, nous ne supportons que l'installation via `brew` pour macOS. Si vous n'utilisez pas [Homebrew](http://brew.sh/), vous pouvez suivre les [instructions d'installation]({{< relref "doc/installation/from-binary.fr-fr.md" >}}) avec le binaire pré-compilé. Pour installer Gitea depuis `brew`, utilisez les commandes suivantes :
3131

3232
```
3333
brew tap go-gitea/gitea

docs/content/doc/installation/from-package.zh-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ menu:
2323

2424
## macOS
2525

26-
macOS 平台下当前我们仅支持通过 `brew` 来安装。如果你没有安装 [Homebrew](http://brew.sh/),你也可以查看 [从二进制安装]({{< relref "from-binary.zh-cn.md" >}})。在你安装了 `brew` 之后, 你可以执行以下命令:
26+
macOS 平台下当前我们仅支持通过 `brew` 来安装。如果你没有安装 [Homebrew](http://brew.sh/),你也可以查看 [从二进制安装]({{< relref "doc/installation/from-binary.zh-cn.md" >}})。在你安装了 `brew` 之后, 你可以执行以下命令:
2727

2828
```
2929
brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
@@ -77,7 +77,7 @@ OpenSUSE 构建服务为 [openSUSE 和 SLE](https://software.opensuse.org/downlo
7777
choco install gitea
7878
```
7979

80-
你也可以 [从二进制安装]({{< relref "from-binary.zh-cn.md" >}}) 。
80+
你也可以 [从二进制安装]({{< relref "doc/installation/from-binary.zh-cn.md" >}}) 。
8181

8282
## FreeBSD
8383

docs/content/doc/installation/from-package.zh-tw.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ menu:
1919

2020
## Linux
2121

22-
目前尚未發佈任何 Linux 套件,如果我們發佈了,會直接更新此網頁。在這之前請先參考[執行檔安裝]({{< relref "from-binary.zh-tw.md" >}})方式。
22+
目前尚未發佈任何 Linux 套件,如果我們發佈了,會直接更新此網頁。在這之前請先參考[執行檔安裝]({{< relref "doc/installation/from-binary.zh-tw.md" >}})方式。
2323

2424
## Windows
2525

@@ -29,11 +29,11 @@ menu:
2929
choco install gitea
3030
```
3131

32-
也可以參考[執行檔安裝]({{< relref "from-binary.zh-tw.md" >}})方式。
32+
也可以參考[執行檔安裝]({{< relref "doc/installation/from-binary.zh-tw.md" >}})方式。
3333

3434
## macOS
3535

36-
目前我們只支援透過 `brew` 來安裝套件。假如您尚未使用 [Homebrew](http://brew.sh/),您就必須參考[執行檔安裝]({{< relref "from-binary.zh-tw.md" >}})方式。透過 `brew` 安裝 Gitea,您只需要執行底下指令:
36+
目前我們只支援透過 `brew` 來安裝套件。假如您尚未使用 [Homebrew](http://brew.sh/),您就必須參考[執行檔安裝]({{< relref "doc/installation/from-binary.zh-tw.md" >}})方式。透過 `brew` 安裝 Gitea,您只需要執行底下指令:
3737

3838
```
3939
brew tap go-gitea/gitea

docs/content/doc/installation/from-source.en-us.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ executable path, you will have to manage this yourself.
3535

3636
**Note 2**: Go version {{< min-go-version >}} or higher is required. However, it is recommended to
3737
obtain the same version as our continuous integration, see the advice given in
38-
<a href='{{< relref "doc/development/hacking-on-gitea.en-us.md" >}}'>Hacking on
39-
Gitea</a>
38+
[Hacking on Gitea]({{< relref "doc/development/hacking-on-gitea.en-us.md" >}})
4039

4140
**Table of Contents**
4241

0 commit comments

Comments
 (0)