diff options
| -rw-r--r-- | doc/development/shell_scripting_guide/index.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/development/shell_scripting_guide/index.md b/doc/development/shell_scripting_guide/index.md index 4f1e7d4cf3c..12ce14f2565 100644 --- a/doc/development/shell_scripting_guide/index.md +++ b/doc/development/shell_scripting_guide/index.md @@ -2,11 +2,11 @@ ## Overview -GitLab consist of many various services and sub-projects. The majority of +GitLab consists of many various services and sub-projects. The majority of their backend code is written in [Ruby](https://www.ruby-lang.org) and [Go](https://golang.org). However, some of them use shell scripts for automation of routine system administration tasks like deployment, -installation, etc. It's being done either for historical reasons or we want +installation, etc. It's being done either for historical reasons or as an effort to minimize the dependencies, for instance, for Docker images. This page aims to define and organize our shell scripting guidelines, @@ -17,6 +17,9 @@ deviations from this guide, they should be described in the ### Word of caution +CAUTION: **Caution:** +This is a must-read section. + Having said all of the above, we recommend staying away from shell scripts as much as possible. A language like Ruby or Python (if required for consistency with codebases that we leverage) is almost always a better choice. |