Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Relay network debugger #1196

Closed
nodkz opened this issue Jun 2, 2016 · 4 comments
Closed

Document Relay network debugger #1196

nodkz opened this issue Jun 2, 2016 · 4 comments

Comments

@nodkz
Copy link
Contributor

nodkz commented Jun 2, 2016

RelayNetworkDebug

From Relay@^0.8.0 available relay requests debugger RelayNetworkDebug

import RelayNetworkDebug from 'react-relay/lib/RelayNetworkDebug';  
RelayNetworkDebug.init();

screenshot

_ _ DEV _ _=true

From Relay@^0.9.0 became availiable relay's extended mutation debugger.
screen shot 2016-06-02 at 12 34 35

For activation via browser's console: type __DEV__=true.
Due webpack build process you may use webpack.BannerPlugin('__DEV__=true;', {raw: true}) or webpack.DefinePlugin({__DEV__: true}).

In Changelog 0.9.0 absent underscores for __DEV__. Not clean understandable how to turn this debugger.

@nodkz
Copy link
Contributor Author

nodkz commented Jun 2, 2016

And again about Documentation

May be somebody add a Debugging article to documentation. Also will be great if leave article about scheduling (thanks to last Joseph talk, I don't know that this cool feature exists).

My english right now is to bad to write articles, and I hate to do it, cause spent a lot of time. I prefer to write some code.

May be at facebook exists so-so-coders that under dismissal ;), and may be somebody will became a brilliant technical writer ;) Good coder IS NOT good writer and vise versa. So for documentation I think should exist dedicated person.

Also it will be interesting to read about Docker's OSS results: https://blog.docker.com/2016/05/open-source-docker-part-1-people/ I think they can not reach such results without their clean documentation.

@BlooJeans
Copy link

BlooJeans commented Jun 2, 2016

PSA: If you're using a custom relay environment, be sure to do

let myEnv = new Relay.Environment();
RelayNetworkDebug.init(myEnv)

@kassens kassens changed the title Relay debuggers Document Relay network debugger Jun 2, 2016
@wincent
Copy link
Contributor

wincent commented Jun 23, 2016

My english right now is to bad to write articles, and I hate to do it, cause spent a lot of time. I prefer to write some code.

This is a legit stance!

Is anybody else able to whip up a PR? I'm cleaning house trying to prepare the next release this week, so I can't promise getting to it myself, but a "Debugging" page in the docs would be great.

Thanks for bringing this up @nodkz, and thanks @BlooJeans for the PSA.

@wincent
Copy link
Contributor

wincent commented May 27, 2017

Closing this as we're unlikely to further document the Relay Classic APIs now that Relay Modern is out. PRs improving the Relay Modern docs, however, would be very welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants