Skip to content

Commit 03ba974

Browse files
Rename custom/conf/app.ini.sample to custom/conf/app.example.ini for better syntax light on editor (#11926)
* Rename custom/conf/app.ini.sample to custom/conf/app.sample.ini for better syntax light on editor * rename to app.example.ini * per @6543 's comment, update all references on docs Co-authored-by: techknowlogick <[email protected]>
1 parent 6c81b73 commit 03ba974

File tree

9 files changed

+9
-9
lines changed

9 files changed

+9
-9
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ coverage.all
5353
/custom/*
5454
!/custom/conf
5555
/custom/conf/*
56-
!/custom/conf/app.ini.sample
56+
!/custom/conf/app.example.ini
5757
/data
5858
/indexers
5959
/log
File renamed without changes.

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ or any corresponding location. When installing from a distribution, this will
2323
typically be found at `/etc/gitea/conf/app.ini`.
2424

2525
The defaults provided here are best-effort (not built automatically). They are
26-
accurately recorded in [app.ini.sample](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
26+
accurately recorded in [app.example.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
2727
(s/master/\<tag|release\>). Any string in the format `%(X)s` is a feature powered
2828
by [ini](https://github.com/go-ini/ini/#recursive-values), for reading values recursively.
2929

@@ -470,7 +470,7 @@ set name for unique queues. Individual queues will default to
470470

471471
- `ENABLED`: **true**: Enable this to allow uploading attachments.
472472
- `PATH`: **data/attachments**: Path to store attachments.
473-
- `ALLOWED_TYPES`: **see app.ini.sample**: Allowed MIME types, e.g. `image/jpeg|image/png`.
473+
- `ALLOWED_TYPES`: **see app.example.ini**: Allowed MIME types, e.g. `image/jpeg|image/png`.
474474
Use `*/*` for all types.
475475
- `MAX_SIZE`: **4**: Maximum size (MB).
476476
- `MAX_FILES`: **5**: Maximum number of attachments that can be uploaded at once.

docs/content/doc/advanced/config-cheat-sheet.zh-cn.md

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

1616
# 配置说明
1717

18-
这是针对Gitea配置文件的说明,你可以了解Gitea的强大配置。需要说明的是,你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。所有默认值可以通过 [app.ini.sample](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) 查看到。如果你发现 `%(X)s` 这样的内容,请查看 [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义,否则最好使用默认值。
18+
这是针对Gitea配置文件的说明,你可以了解Gitea的强大配置。需要说明的是,你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。所有默认值可以通过 [app.example.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) 查看到。如果你发现 `%(X)s` 这样的内容,请查看 [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义,否则最好使用默认值。
1919

2020
## Overall (`DEFAULT`)
2121

docs/content/doc/advanced/customizing-gitea.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Again `gitea help` will allow you review this variable and you can override it u
3535
`--config` option on the `gitea` binary.
3636

3737
- [Quick Cheat Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/)
38-
- [Complete List](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
38+
- [Complete List](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
3939

4040
If the `CustomPath` folder can't be found despite checking `gitea help`, check the `GITEA_CUSTOM`
4141
environment variable; this can be used to override the default path to something else.

docs/content/doc/advanced/customizing-gitea.zh-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板
2222
`custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接,查看配置详情请移步:
2323

2424
- [快速备忘单](https://docs.gitea.io/en-us/config-cheat-sheet/)
25-
- [完整配置清单](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
25+
- [完整配置清单](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
2626

2727
如果您在 binary 同目录下无法找到 `custom` 文件夹,请检查您的 `GITEA_CUSTOM`
2828
环境变量配置, 因为它可能被配置到了其他地方(可能被一些启动脚本设置指定了目录)。

docs/content/doc/features/authentication.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Both the LDAP via BindDN and the simple auth LDAP share the following fields:
9696
the LDAP server. The default period is every 24 hours but that can be
9797
changed in the app.ini file. See the *cron.sync_external_users* section in
9898
the [sample
99-
app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
99+
app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
100100
for detailed comments about that section. The *User Search Base* and *User
101101
Filter* settings described above will limit which users can use Gitea and
102102
which users will be synchronized. When initially run the task will create

docs/content/page/index.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Windows, on architectures like amd64, i386, ARM, PowerPC, and others.
7575
- MSSQL
7676
- TiDB (experimental, not recommended)
7777
- Configuration file
78-
- [app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
78+
- [app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
7979
- Admin panel
8080
- Statistics
8181
- Actions

docs/content/page/index.fr-fr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Le but de ce projet est de fournir de la manière la plus simple, la plus rapide
7070
- MSSQL
7171
- [TiDB](https://github.com/pingcap/tidb) (expérimental)
7272
- Fichier de configuration
73-
- Voir [ici](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample)
73+
- Voir [ici](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
7474
- Panel d'administration
7575
- Statistiques
7676
- Actions

0 commit comments

Comments
 (0)