From f7605c08dd25ef5b8abb24b49c0c97bab5b6033c Mon Sep 17 00:00:00 2001 From: Lin Jen-Shin Date: Wed, 22 Jun 2016 16:39:25 +0800 Subject: [PATCH 1/2] Add some clarification for some files under config/* I didn't add a lot of them because I am not very familiar about how they work and I am not sure if we really need to explain files like config/database.yml because if you know Rails you must know how that works. At any rate, I think this is a beginning and we could keep documenting more files in the future. Closes #18373 --- config/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 config/README.md diff --git a/config/README.md b/config/README.md new file mode 100644 index 00000000000..db49bcb775f --- /dev/null +++ b/config/README.md @@ -0,0 +1,21 @@ +# 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 +[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. + +## 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. + +## 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. From deb39a017685c303cbaad2e9a07c8fb9b1636e67 Mon Sep 17 00:00:00 2001 From: Lin Jen-Shin Date: Thu, 23 Jun 2016 11:45:06 +0800 Subject: [PATCH 2/2] Update wordings by feedback from: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/4851 --- config/README.md | 15 ++++++++------- 1 file 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.