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

add section for universal code

Browse source
This commit is contained in:
Mike Greiling 2018-03-12 15:24:55 -05:00
parent ab8ad58ea1
commit ae47afb9fd
No known key found for this signature in database
GPG key ID: 0303DF507FA67596
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/development/fe_guide/performance.md
View file

@ -47,6 +47,15 @@ properties once, and handle the actual animation with transforms.
## Reducing Asset Footprint
### Universal code
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
needed _everywhere_. This includes ubiquitous libraries like `vue`, `axios`,
and `jQuery`, as well as code for the main navigation and sidebar. Where
possible we should aim to remove modules from these bundles to reduce our code
footprint.
### Page-specific JavaScript
Webpack has been configured to automatically generate entry point bundles based
@ -75,11 +84,6 @@ In addition to these page-specific bundles, the code within `main.js` and
can find this out by checking `document.body.dataset.page` while on any page
within gitlab.com.
- Since `main.js` and `commons/index.js` are imported on all pages, it is
important to not add anything to these bundles unless it is truly needed
_everywhere_. This includes ubiquitous libraries like `vue`, `axios`, and
`jQuery`, as well as code for the main navigation and sidebar.
- Page-specific javascript entry points should be as lite as possible. These
files are exempt from tests, and should be used primarily for instantiation
and dependency injection of classes and methods that live in modules outside