diff options
author | Lin Jen-Shin <godfat@godfat.org> | 2016-06-23 11:45:06 +0800 |
---|---|---|
committer | Lin Jen-Shin <godfat@godfat.org> | 2016-06-23 11:45:06 +0800 |
commit | deb39a017685c303cbaad2e9a07c8fb9b1636e67 (patch) | |
tree | 39735e9fa2df75ba55f1ff9282250c1ded16419a /config/README.md | |
parent | f7605c08dd25ef5b8abb24b49c0c97bab5b6033c (diff) | |
download | gitlab-ce-deb39a017685c303cbaad2e9a07c8fb9b1636e67.tar.gz |
Update wordings by feedback from:doc-for-config
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4851
Diffstat (limited to 'config/README.md')
-rw-r--r-- | config/README.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/config/README.md b/config/README.md index db49bcb775f..0a5ea2424e0 100644 --- a/config/README.md +++ b/config/README.md @@ -1,21 +1,22 @@ # Configuration files Documentation Note that most configuration files (`config/*.*`) committed into -[gitlab-ce](https://gitlab.com/gitlab-org/gitlab-ce) **would not be used** for +[gitlab-ce](https://gitlab.com/gitlab-org/gitlab-ce) **will not be used** for [omnibus-gitlab](https://gitlab.com/gitlab-org/omnibus-gitlab). Configuration files committed into gitlab-ce are only used for development. ## gitlab.yml -You could find most of GitLab configuration here. +You can find most of GitLab configuration settings here. ## mail_room.yml -It's intended to be an ERB file because `mail_room` would use ERB to evaluate -it before parsing it as a YAML file. It would try to read values from -`gitlab.yml` so you should configure it there. +This file is actually an YML wrapped inside an ERB file to enable templated +values to be specified from `gitlab.yml`. mail_room loads this file first as +an ERB file and then loads the resulting YML as its configuration. ## resque.yml -It's called `resque.yml` for historical reason, and we're not using rescue -at the moment. It's served as a **Redis configuration file** instead. +This file is called `resque.yml` for historical reasons. We are **NOT** +using Resque at the moment. It is used to specify Redis configuration +values instead. |