summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Zagorodny <vzagorodny@gitlab.com>2019-07-09 17:12:58 +0300
committerVictor Zagorodny <vzagorodny@gitlab.com>2019-07-09 17:12:58 +0300
commit72fe593f805e0fe6cdd382a58772ce6a3398d0ff (patch)
treebdbd5b5c7aa089aa54dd3f98953aa1e5b5e93a41
parentfb55409d07c592fb088df6f87399b198e18bfa7d (diff)
downloadgitlab-ce-72fe593f805e0fe6cdd382a58772ce6a3398d0ff.tar.gz
Improve wording and fix typos in several placesˆ
-rw-r--r--doc/development/shell_scripting_guide/index.md7
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.