kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Update Gotchas doc 

[ci skip]
This commit is contained in:
Robert Speicher 2016-02-17 15:35:28 -05:00
parent 6053ad8474
commit 0afe2e0513
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/development/gotchas.md
View File

@ -46,8 +46,8 @@ Rubocop](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-4-stable/.rubocop.yml#L9
Using the inline `:coffee` or `:coffeescript` Haml filters comes with a Using the inline `:coffee` or `:coffeescript` Haml filters comes with a
performance overhead. performance overhead.
We've [removed these two filters entirely](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-5-stable/config/initializers/haml.rb) _**Note:** We've [removed these two filters](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-5-stable/config/initializers/haml.rb)
through an initializer. in an initializer._
### Further reading ### Further reading
@ -63,21 +63,20 @@ perfectly fine to write some JavaScript like the following:
$('#js-my-selector').hide(); $('#js-my-selector').hide();
``` ```
But there's a feature of GitLab's Markdown processing that will automatically However, there's a feature of GitLab's Markdown processing that [automatically
add `id` attributes underneath header elements in order to make them linkable. adds anchors to header elements][ToC Processing], with the `id` attribute being
The content of the header is ["dasherized"][ToC Processing] and used in the `id` automatically generated based on the content of the header.
attribute.
Unfortunately, this feature makes it possible for user-generated content to Unfortunately, this feature makes it possible for user-generated content to
create a header element with the same `id` attribute we're using in our create a header element with the same `id` attribute we're using in our
selector, potentially breaking the JavaScript behavior. A user could break the selector, potentially breaking the JavaScript behavior. A user could break the
above example JavaScript with the following Markdown: above example with the following Markdown:
```markdown ```markdown
## JS My Selector ## JS My Selector
``` ```
Which gets converted to the following HTML after processing: Which gets converted to the following HTML:
```html ```html
<h2> <h2>