summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTim Zallmann <tzallmann@gitlab.com>2018-06-01 15:51:26 +0000
committerTim Zallmann <tzallmann@gitlab.com>2018-06-01 15:51:26 +0000
commitc5f89e5bd7f9371882de8b6ad62d24467b22937b (patch)
tree3bdae625bbbe5e183f8095722816d54d964e429b /doc
parent39d2fa082e07829f13e8b7321ec0057ad77dffee (diff)
parent0a1b2a009ed9f0a527344bdf8ffcd46833e30111 (diff)
downloadgitlab-ce-c5f89e5bd7f9371882de8b6ad62d24467b22937b.tar.gz
Merge branch 'docs-update-fe-dependencies-guide' into 'master'
Update FE guides with dependency/devDependency distinction See merge request gitlab-org/gitlab-ce!19287
Diffstat (limited to 'doc')
-rw-r--r--doc/development/new_fe_guide/dependencies.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/development/new_fe_guide/dependencies.md b/doc/development/new_fe_guide/dependencies.md
index 3417d77a06d..12a4f089d41 100644
--- a/doc/development/new_fe_guide/dependencies.md
+++ b/doc/development/new_fe_guide/dependencies.md
@@ -1,3 +1,20 @@
# Dependencies
-> TODO: Add Dependencies \ No newline at end of file
+## Adding Dependencies.
+
+GitLab uses `yarn` to manage dependencies. These dependencies are defined in
+two groups within `package.json`, `dependencies` and `devDependencies`. For
+our purposes, we consider anything that is required to compile our production
+assets a "production" dependency. That is, anything required to run the
+`webpack` script with `NODE_ENV=production`. Tools like `eslint`, `karma`, and
+various plugins and tools used in development are considered `devDependencies`.
+This distinction is used by omnibus to determine which dependencies it requires
+when building GitLab.
+
+Exceptions are made for some tools that we require in the
+`gitlab:assets:compile` CI job such as `webpack-bundle-analyzer` to analyze our
+production assets post-compile.
+
+---
+
+> TODO: Add Dependencies