add documentation regarding raven-teskit plugin #1231
Conversation
|
Nice! I'll try to give it a look this week :) Cheers! |
|
Sorry for the delay @zivl, we're kinda swamped with work now. I'll try to get this done soon. |
|
@kamilogorek anything new? anything I can help to make it ease with your review? |
docs/sentry-doc-config.json
Outdated
| @@ -11,6 +11,14 @@ | |||
| "index#reporting-errors" | |||
| ] | |||
| }, | |||
| "javascript.textkit": { | |||
There was a problem hiding this comment.
This entry is used for a "Framework selection panel" when creating a new project, so we cannot really add it here
There was a problem hiding this comment.
where do you think it suites the most?
There was a problem hiding this comment.
oh... saw your comment below about the Tips & Tricks
docs/integrations/raven-testkit.rst
Outdated
|
|
||
| .. code-block:: javascript | ||
|
|
||
| const testKit = testKitInitializer(Raven) |
There was a problem hiding this comment.
I'd include Raven import here to not confuse users, as right now it somehow just magically appears out of nowhere :)
docs/integrations/raven-testkit.rst
Outdated
|
|
||
| .. code-block:: javascript | ||
|
|
||
| import testKitInitializer from 'raven-testkit' |
docs/integrations/raven-testkit.rst
Outdated
| import testKitInitializer from 'raven-testkit' | ||
|
|
||
|
|
||
| Then you may create a `testkit` instance and validate your reports against it as follows: |
There was a problem hiding this comment.
Double-ticks has to be used as it's RST, not markdown
docs/integrations/index.rst
Outdated
| @@ -40,6 +40,7 @@ To install a plugin just include the plugin **after** Raven has been loaded and | |||
| ember | |||
| react | |||
| vue | |||
| raven-testkit | |||
There was a problem hiding this comment.
Are you aware that it'll only show up here https://docs.sentry.io/clients/javascript/integrations/ and not in the sidebar? I'd not add it to the sidebar anyway, as it's more a helpful tool than framework integration.
Let's maybe add a section in in Tips and Tricks that can mention it and link to the integration page?
There was a problem hiding this comment.
Or just completely move it to Tips and Tricks section instead of a separate page? As, as I've mentioned before, it's not really an integration :)
There was a problem hiding this comment.
ok. will move it there :)
|
Thanks for your patience @zivl, got completely swamped in other things. Reviewed now :) |
|
Hey @kamilogorek, |
|
Thanks @zivl! :) |
I've written a test-kit for the raven-js library, I think it should be added to the documentation.
I know I looked for something like that A LOT for my development and testing purposes but since such was not exist - I wrote one!
so here it is: https://github.com/wix/raven-testkit
Hope you like it, and will be happy to get your feedback!
Enjoy!
Ziv