Skip to content

Commit 8852a59

Browse files
authored
Update docs for docusaurus v3 (#28128)
Signed-off-by: jolheiser <[email protected]>
1 parent 8c771c8 commit 8852a59

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Inside the `gitea-dump-1482906742.zip` file, will be the following:
4242

4343
- `app.ini` - Optional copy of configuration file if originally stored outside of the default `custom/` directory
4444
- `custom` - All config or customization files in `custom/`.
45-
- `data` - Data directory in <GITEA_WORK_DIR>, except sessions if you are using file session. This directory includes `attachments`, `avatars`, `lfs`, `indexers`, SQLite file if you are using SQLite.
45+
- `data` - Data directory in `<GITEA_WORK_DIR>`, except sessions if you are using file session. This directory includes `attachments`, `avatars`, `lfs`, `indexers`, SQLite file if you are using SQLite.
4646
- `gitea-db.sql` - SQL dump of database
4747
- `gitea-repo.zip` - Complete copy of the repository directory.
4848
- `log/` - Various logs. They are not needed for a recovery or migration.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
337337
- `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** or **username, email**: \[off, username, email, anything\]: Specify the principals values that users are allowed to use as principal. When set to `anything` no checks are done on the principal string. When set to `off` authorized principal are not allowed to be set.
338338
- `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: Gitea will create a authorized_principals file by default when it is not using the internal ssh server and `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`.
339339
- `SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**: Enable SSH Authorized Principals Backup when rewriting all keys, default is true if `SSH_AUTHORIZED_PRINCIPALS_ALLOW` is not `off`.
340-
- `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}**: Set the template for the command to passed on authorized keys. Possible keys are: AppPath, AppWorkPath, CustomConf, CustomPath, Key - where Key is a `models/asymkey.PublicKey` and the others are strings which are shellquoted.
340+
- `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **`{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}`**: Set the template for the command to passed on authorized keys. Possible keys are: AppPath, AppWorkPath, CustomConf, CustomPath, Key - where Key is a `models/asymkey.PublicKey` and the others are strings which are shellquoted.
341341
- `SSH_SERVER_CIPHERS`: **[email protected], aes128-ctr, aes192-ctr, aes256-ctr, [email protected], [email protected]**: For the built-in SSH server, choose the ciphers to support for SSH connections, for system SSH this setting has no effect.
342342
- `SSH_SERVER_KEY_EXCHANGES`: **curve25519-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha256, diffie-hellman-group14-sha1**: For the built-in SSH server, choose the key exchange algorithms to support for SSH connections, for system SSH this setting has no effect.
343343
- `SSH_SERVER_MACS`: **[email protected], hmac-sha2-256, hmac-sha1**: For the built-in SSH server, choose the MACs to support for SSH connections, for system SSH this setting has no effect
@@ -1366,7 +1366,7 @@ jobs:
13661366
- uses: actions/checkout@v3
13671367
```
13681368
1369-
Now we need to know how to get actions/checkout, this configuration is the default git server to get it. That means we will get the repository via git clone ${DEFAULT_ACTIONS_URL}/actions/checkout and fetch tag v3.
1369+
Now we need to know how to get actions/checkout, this configuration is the default git server to get it. That means we will get the repository via git clone `${DEFAULT_ACTIONS_URL}/actions/checkout` and fetch tag v3.
13701370

13711371
To help people who don't want to mirror these actions in their git instances, the default value is https://gitea.com
13721372
To help people run actions totally in their network, they can change the value and copy all necessary action repositories into their git server.

docs/content/help/faq.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,9 @@ All Gitea instances have the built-in API and there is no way to disable it comp
140140
You can, however, disable showing its documentation by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini`.
141141
For more information, refer to Gitea's [API docs](development/api-usage.md).
142142

143-
You can see the latest API (for example) on <https://try.gitea.io/api/swagger>.
143+
You can see the latest API (for example) on https://try.gitea.io/api/swagger
144144

145-
You can also see an example of the `swagger.json` file at <https://try.gitea.io/swagger.v1.json>.
145+
You can also see an example of the `swagger.json` file at https://try.gitea.io/swagger.v1.json
146146

147147
## Adjusting your server for public/private use
148148

docs/content/help/faq.zh-cn.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供
142142
但是,您可以在app.ini的api部分将ENABLE_SWAGGER设置为false,以禁用其文档显示。
143143
有关更多信息,请参阅Gitea的[API文档](development/api-usage.md)
144144

145-
您可以在上查看最新的API(例如)<https://try.gitea.io/api/swagger>
145+
您可以在上查看最新的API(例如)https://try.gitea.io/api/swagger
146146

147-
您还可以在上查看`swagger.json`文件的示例 <https://try.gitea.io/swagger.v1.json>
147+
您还可以在上查看`swagger.json`文件的示例 https://try.gitea.io/swagger.v1.json
148148

149149
## 调整服务器用于公共/私有使用
150150

@@ -346,7 +346,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库,然后您
346346
- 转到您的`站点管理 -> 用户账户`页面并编辑用户。
347347
- 使用[管理 CLI 命令](administration/command-line.md#admin)
348348

349-
请注意,大多数命令还需要一个[全局标志]({{< relref "doc/administration/command-line.zh-cn.- md#global-options" >}})来指向正确的配置。
349+
请注意,大多数命令还需要一个[全局标志](administration/command-line.md#global-options)来指向正确的配置。
350350
- 作为**用户**,您可以更改密码...
351351
- 在您的账户的`设置 -> 账户`页面(此方法**需要**您知道当前密码)。
352352
- 使用`忘记密码`链接。

docs/content/usage/linked-references.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Sometimes a commit or pull request may fix or bring back a problem documented
9292
in a particular issue. Gitea supports closing and reopening the referenced
9393
issues by preceding the reference with a particular _keyword_. Common keywords
9494
include "closes", "fixes", "reopens", etc. This list can be
95-
[customized]({{< ref "doc/administration/config-cheat-sheet.en-us.md" >}}) by the
95+
[customized](administration/config-cheat-sheet.md) by the
9696
site administrator.
9797

9898
Example:

docs/content/usage/linked-references.zh-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ menu:
6666

6767
## 可操作的引用在合并请求和提交消息中
6868

69-
有时,一个提交或合并请求可能会修复或重新出现在某个特定工单中。Gitea 支持在引用之前加上特定的“关键字”来关闭和重新打开被引用的工单。常见的关键字包括“closes”、“fixes”、“reopens”等。这个列表可以由站点管理员进行 [自定义]({{< ref "doc/administration/config-cheat-sheet.zh-cn.md" >}})。
69+
有时,一个提交或合并请求可能会修复或重新出现在某个特定工单中。Gitea 支持在引用之前加上特定的“关键字”来关闭和重新打开被引用的工单。常见的关键字包括“closes”、“fixes”、“reopens”等。这个列表可以由站点管理员进行 [自定义](administration/config-cheat-sheet.md)
7070

7171
示例:
7272

0 commit comments

Comments
 (0)