diff options
author | Fatih Acet <acetfatih@gmail.com> | 2016-11-01 15:45:29 +0000 |
---|---|---|
committer | Fatih Acet <acetfatih@gmail.com> | 2016-11-01 15:45:29 +0000 |
commit | aba94f65f039908d14643f3854e3c2901ff843aa (patch) | |
tree | 6565d0e2a41337ec1716d6b7fd007eecb1416f33 /doc | |
parent | 7e0cab4f2b9f772c6019afd74a797cdb8ed25f43 (diff) | |
parent | 5fb226a934b07b214dcbd6711f1068866c0c1dae (diff) | |
download | gitlab-ce-aba94f65f039908d14643f3854e3c2901ff843aa.tar.gz |
Merge branch 'decaffeinate-the-docs' into 'master'
Remove leftover references to coffeescript from comments and docs.
I was looking at the front-end helper spec and noticed some outdated coffeescript refs in it. So I figured it wouldn't hurt to take a few minutes and remove all the coffeescript references in CE that we don't need anymore.
I didn't touch any coffeescript references that could potentially break anything. Just docs and code comments.
- [x] All builds are passing
See merge request !7151
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/gotchas.md | 6 | ||||
-rw-r--r-- | doc/development/testing.md | 4 |
2 files changed, 4 insertions, 6 deletions
diff --git a/doc/development/gotchas.md b/doc/development/gotchas.md index 159d5ce286d..b25ce79e89f 100644 --- a/doc/development/gotchas.md +++ b/doc/development/gotchas.md @@ -41,9 +41,9 @@ Rubocop](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-4-stable/.rubocop.yml#L9 [Exception]: http://stackoverflow.com/q/10048173/223897 -## Don't use inline CoffeeScript/JavaScript in views +## Don't use inline JavaScript in views -Using the inline `:coffee` or `:coffeescript` Haml filters comes with a +Using the inline `:javascript` Haml filters comes with a performance overhead. Using inline JavaScript is not a good way to structure your code and should be avoided. _**Note:** We've [removed these two filters](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/initializers/hamlit.rb) @@ -51,9 +51,7 @@ in an initializer._ ### Further reading -- Pull Request: [Replace CoffeeScript block into JavaScript in Views](https://git.io/vztMu) - Stack Overflow: [Why you should not write inline JavaScript](http://programmers.stackexchange.com/questions/86589/why-should-i-avoid-inline-scripting) -- Stack Overflow: [Performance implications of using :coffescript filter inside HAML templates?](http://stackoverflow.com/a/17571242/223897) ## ID-based CSS selectors need to be a bit more specific diff --git a/doc/development/testing.md b/doc/development/testing.md index 513457d203a..8e91ac5e3ba 100644 --- a/doc/development/testing.md +++ b/doc/development/testing.md @@ -36,8 +36,8 @@ the command line via `bundle exec teaspoon`, or via a web browser at `http://localhost:3000/teaspoon` when the Rails server is running. - JavaScript tests live in `spec/javascripts/`, matching the folder structure of - `app/assets/javascripts/`: `app/assets/javascripts/behaviors/autosize.js.coffee` has a corresponding - `spec/javascripts/behaviors/autosize_spec.js.coffee` file. + `app/assets/javascripts/`: `app/assets/javascripts/behaviors/autosize.js.es6` has a corresponding + `spec/javascripts/behaviors/autosize_spec.js.es6` file. - Haml fixtures required for JavaScript tests live in `spec/javascripts/fixtures`. They should contain the bare minimum amount of markup necessary for the test. |