Please document how plugins should be included

[tarjei]

I find it very frustrating that the plugins page does not contain any information on how plugins should be included in Raven.

@see:
https://docs.getsentry.com/hosted/clients/javascript/plugins/

[mattrobenolt]

Our documentation here should be sufficient after glancing over it: https://docs.getsentry.com/hosted/clients/javascript/integrations/

Not sure if this is still confusing, but the changes also done in #392 make it less of an issue since plugins are now installed lazily.

[tarjei]

I disagree, here's a stab at a paragraph:

Installation

To install a plugin just include the plugin after Raven has been loaded and the Raven global variable is registered.

---

The text above is sufficient. Not stating this explicitly makes users (at least me) wonder if a plugin installation worked or not and when the plugin should be loaded.

[mattrobenolt]

That's fair.

Question: how were you attempting to use Raven to where this was confusing? If it's pulled from our CDN, this shouldn't matter since we already bundle it correctly and in the right order.

And at the moment, it's pretty counter intuitive to load plugins by themselves outside of our bundled CDN versions.

So just curious what you were attempting to do so I have the full context. :)

[tarjei]

No problem :)

I'm bundling raven using webpack and commonjs (i.e. Raven = require('raven')). I also added some extra plugins at a point.

One thing that hit me later was that if you require raven twice then it looses the initial configuration. If possible, the CommonJS(i.e. NPM) version of Raven should have a check so that multiple requires do not overwrite the initial instance.

[tarjei]

A paragraph realting to usage with CommonJS is probably also a good idea :)

Suggestion:
CommonJS

If you load and install Raven using commonJS you should be aware that multiple require's will overwrite the window.Raven instance and thus give you a Raven instance that is not configured.

[mattrobenolt]

Hmmmmm, that's a good point about the CommonJS case. That seems like a separate bug though. Would you mind opening another ticket to address that?

[tarjei]

I created PRs for both issues.