address wording feedback

This commit is contained in:
Mike Greiling 2018-03-12 17:42:38 -05:00
parent 43ceaf494f
commit d92baff68f
No known key found for this signature in database
GPG key ID: 0303DF507FA67596

View file

@ -51,18 +51,18 @@ properties once, and handle the actual animation with transforms.
Code that is contained within `main.js` and `commons/index.js` are loaded and Code that is contained within `main.js` and `commons/index.js` are loaded and
run on _all_ pages. **DO NOT ADD** anything to these files unless it is truly run on _all_ pages. **DO NOT ADD** anything to these files unless it is truly
needed _everywhere_. This includes ubiquitous libraries like `vue`, `axios`, needed _everywhere_. These bundles include ubiquitous libraries like `vue`,
and `jQuery`, as well as code for the main navigation and sidebar. Where `axios`, and `jQuery`, as well as code for the main navigation and sidebar.
possible we should aim to remove modules from these bundles to reduce our code Where possible we should aim to remove modules from these bundles to reduce our
footprint. code footprint.
### Page-specific JavaScript ### Page-specific JavaScript
Webpack has been configured to automatically generate entry point bundles based Webpack has been configured to automatically generate entry point bundles based
on the file structure within `app/assets/javascripts/pages/*`. The directories on the file structure within `app/assets/javascripts/pages/*`. The directories
within the `pages` directory are meant to correspond to Rails controllers and within the `pages` directory correspond to Rails controllers and actions. These
actions. These auto-generated bundles will be automatically included on the auto-generated bundles will be automatically included on the corresponding
corresponding pages. pages.
For example, if you were to visit [gitlab.com/gitlab-org/gitlab-ce/issues](https://gitlab.com/gitlab-org/gitlab-ce/issues), For example, if you were to visit [gitlab.com/gitlab-org/gitlab-ce/issues](https://gitlab.com/gitlab-org/gitlab-ce/issues),
you would be accessing the `app/controllers/projects/issues_controller.rb` you would be accessing the `app/controllers/projects/issues_controller.rb`
@ -82,8 +82,8 @@ In addition to these page-specific bundles, the code within `main.js` and
- **Identifying Controller Paths:** - **Identifying Controller Paths:**
If you are unsure what controller and action corresponds to a given page, you If you are unsure what controller and action corresponds to a given page, you
can find this out by checking `document.body.dataset.page` while on any page can find this out by inspecting `document.body.dataset.page` within your
within gitlab.com. browser's developer console while on any page within gitlab.
- **Keep Entry Points Lite:** - **Keep Entry Points Lite:**
Page-specific javascript entry points should be as lite as possible. These Page-specific javascript entry points should be as lite as possible. These