From 03ba974481296b76f87cbd756e41ecf5be9d006b Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Thu, 18 Jun 2020 11:16:59 +0800 Subject: [PATCH] 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 --- .gitignore | 2 +- custom/conf/{app.ini.sample => app.example.ini} | 0 docs/content/doc/advanced/config-cheat-sheet.en-us.md | 4 ++-- docs/content/doc/advanced/config-cheat-sheet.zh-cn.md | 2 +- docs/content/doc/advanced/customizing-gitea.en-us.md | 2 +- docs/content/doc/advanced/customizing-gitea.zh-cn.md | 2 +- docs/content/doc/features/authentication.en-us.md | 2 +- docs/content/page/index.en-us.md | 2 +- docs/content/page/index.fr-fr.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) rename custom/conf/{app.ini.sample => app.example.ini} (100%) diff --git a/.gitignore b/.gitignore index 9c4a15c9cccd..90a103eca11c 100644 --- a/.gitignore +++ b/.gitignore @@ -53,7 +53,7 @@ coverage.all /custom/* !/custom/conf /custom/conf/* -!/custom/conf/app.ini.sample +!/custom/conf/app.example.ini /data /indexers /log diff --git a/custom/conf/app.ini.sample b/custom/conf/app.example.ini similarity index 100% rename from custom/conf/app.ini.sample rename to custom/conf/app.example.ini diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index 13c5f987adba..96f03ad3fda5 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -23,7 +23,7 @@ or any corresponding location. When installing from a distribution, this will typically be found at `/etc/gitea/conf/app.ini`. The defaults provided here are best-effort (not built automatically). They are -accurately recorded in [app.ini.sample](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) +accurately recorded in [app.example.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) (s/master/\). Any string in the format `%(X)s` is a feature powered by [ini](https://github.com/go-ini/ini/#recursive-values), for reading values recursively. @@ -470,7 +470,7 @@ set name for unique queues. Individual queues will default to - `ENABLED`: **true**: Enable this to allow uploading attachments. - `PATH`: **data/attachments**: Path to store attachments. -- `ALLOWED_TYPES`: **see app.ini.sample**: Allowed MIME types, e.g. `image/jpeg|image/png`. +- `ALLOWED_TYPES`: **see app.example.ini**: Allowed MIME types, e.g. `image/jpeg|image/png`. Use `*/*` for all types. - `MAX_SIZE`: **4**: Maximum size (MB). - `MAX_FILES`: **5**: Maximum number of attachments that can be uploaded at once. diff --git a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md index 082944c8a4a2..af141df47c31 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md +++ b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md @@ -15,7 +15,7 @@ menu: # 配置说明 -这是针对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: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 +这是针对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: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 ## Overall (`DEFAULT`) diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/advanced/customizing-gitea.en-us.md index b52a713e40af..d6a2019ac039 100644 --- a/docs/content/doc/advanced/customizing-gitea.en-us.md +++ b/docs/content/doc/advanced/customizing-gitea.en-us.md @@ -35,7 +35,7 @@ Again `gitea help` will allow you review this variable and you can override it u `--config` option on the `gitea` binary. - [Quick Cheat Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) -- [Complete List](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) +- [Complete List](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) If the `CustomPath` folder can't be found despite checking `gitea help`, check the `GITEA_CUSTOM` environment variable; this can be used to override the default path to something else. diff --git a/docs/content/doc/advanced/customizing-gitea.zh-cn.md b/docs/content/doc/advanced/customizing-gitea.zh-cn.md index 7cf2041e0e77..91762b13d96b 100644 --- a/docs/content/doc/advanced/customizing-gitea.zh-cn.md +++ b/docs/content/doc/advanced/customizing-gitea.zh-cn.md @@ -22,7 +22,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板 `custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接，查看配置详情请移步： - [快速备忘单](https://docs.gitea.io/en-us/config-cheat-sheet/) -- [完整配置清单](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) +- [完整配置清单](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) 如果您在 binary 同目录下无法找到 `custom` 文件夹，请检查您的 `GITEA_CUSTOM` 环境变量配置， 因为它可能被配置到了其他地方（可能被一些启动脚本设置指定了目录）。 diff --git a/docs/content/doc/features/authentication.en-us.md b/docs/content/doc/features/authentication.en-us.md index bc4c33ad4d74..7b295dd1d166 100644 --- a/docs/content/doc/features/authentication.en-us.md +++ b/docs/content/doc/features/authentication.en-us.md @@ -96,7 +96,7 @@ Both the LDAP via BindDN and the simple auth LDAP share the following fields: the LDAP server. The default period is every 24 hours but that can be changed in the app.ini file. See the *cron.sync_external_users* section in the [sample - app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) + app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) for detailed comments about that section. The *User Search Base* and *User Filter* settings described above will limit which users can use Gitea and which users will be synchronized. When initially run the task will create diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md index c9dd1ab3c4e5..027fcbfcc985 100644 --- a/docs/content/page/index.en-us.md +++ b/docs/content/page/index.en-us.md @@ -75,7 +75,7 @@ Windows, on architectures like amd64, i386, ARM, PowerPC, and others. - MSSQL - TiDB (experimental, not recommended) - Configuration file - - [app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) + - [app.ini](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) - Admin panel - Statistics - Actions diff --git a/docs/content/page/index.fr-fr.md b/docs/content/page/index.fr-fr.md index a6109b441a2c..9b9743c103b2 100755 --- a/docs/content/page/index.fr-fr.md +++ b/docs/content/page/index.fr-fr.md @@ -70,7 +70,7 @@ Le but de ce projet est de fournir de la manière la plus simple, la plus rapide - MSSQL - [TiDB](https://github.com/pingcap/tidb) (expérimental) - Fichier de configuration - - Voir [ici](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample) + - Voir [ici](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini) - Panel d'administration - Statistiques - Actions