diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-17 14:59:07 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-17 14:59:07 +0300 |
| commit | 8b573c94895dc0ac0e1d9d59cf3e8745e8b539ca (patch) | |
| tree | 544930fb309b30317ae9797a9683768705d664c4 /doc/development/gotchas.md | |
| parent | 4b1de649d0168371549608993deac953eb692019 (diff) | |
Add latest changes from gitlab-org/gitlab@13-7-stable-eev13.7.0-rc42
Diffstat (limited to 'doc/development/gotchas.md')
| -rw-r--r-- | doc/development/gotchas.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/development/gotchas.md b/doc/development/gotchas.md index 691027f385f..2b34aedddf6 100644 --- a/doc/development/gotchas.md +++ b/doc/development/gotchas.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Gotchas @@ -14,7 +14,7 @@ might encounter or should avoid during development of GitLab CE and EE. In GitLab 10.8 and later, Omnibus has [dropped the `app/assets` directory](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/2456), after asset compilation. The `ee/app/assets`, `vendor/assets` directories are dropped as well. -This means that reading files from that directory will fail in Omnibus-installed GitLab instances: +This means that reading files from that directory fails in Omnibus-installed GitLab instances: ```ruby file = Rails.root.join('app/assets/images/logo.svg') @@ -243,8 +243,8 @@ end In this case, if for any reason the top level `ApplicationController` is loaded but `Projects::ApplicationController` is not, `ApplicationController` -would be resolved to `::ApplicationController` and then the `project` method will -be undefined and we will get an error. +would be resolved to `::ApplicationController` and then the `project` method is +undefined, causing an error. #### Solution @@ -264,8 +264,8 @@ end By specifying `Projects::`, we tell Rails exactly what class we are referring to and we would avoid the issue. -NOTE: **Note:** -This problem will disappear as soon as we upgrade to Rails 6 and use the Zeitwerk autoloader. +NOTE: +This problem disappears as soon as we upgrade to Rails 6 and use the Zeitwerk autoloader. ### Further reading @@ -292,7 +292,7 @@ While the code above works in local environments, it errors out in production in ### Solution -The alternative is the `lib/assets` folder. Use it if you need to add assets (like images) to the repo that meet the following conditions: +The alternative is the `lib/assets` folder. Use it if you need to add assets (like images) to the repository that meet the following conditions: - The assets do not need to be directly served to the user (and hence need not be pre-compiled). - The assets do need to be accessed via application code. |