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

docs: move and update inspector help #1216

Closed
wants to merge 0 commits into from
Closed

docs: move and update inspector help #1216

wants to merge 0 commits into from

Conversation

joshgav
Copy link
Contributor

@joshgav joshgav commented May 3, 2017

Per feedback in nodejs/node#11207, copying Inspector guide to a simpler path and removing background info.

@joshgav joshgav requested a review from ofrobots May 3, 2017 18:17
@joshgav
Copy link
Contributor Author

joshgav commented May 3, 2017

cc @nodejs/diagnostics

joshgav added a commit that referenced this pull request May 4, 2017
PR-URL: #1216
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jan Krems <jan.krems@gmail.com>
@joshgav joshgav closed this May 4, 2017
@joshgav
Copy link
Contributor Author

joshgav commented May 4, 2017

Landed in 13eaf4c. Thanks!

@ofrobots
Copy link
Contributor

ofrobots commented May 4, 2017

I am concerned this landed without review from folks from the DevTools team. /cc @eugeneo @pavelfeldman.

@jkrems
Copy link

jkrems commented May 4, 2017

Sorry, didn't fully realize that we now have 2 copies of the "same" guide:

There's also overlap with the debugger docs page, specifically the "Advanced Usage" section. It might be good to do another pass to unify & cross-link to make sure each of the URLs provides value and we don't duplicate information. Imo iterating on the docs shouldn't have to block the node PR though as long as it points to a valid URL.

@joshgav
Copy link
Contributor Author

joshgav commented May 4, 2017

@jkrems I left the old version up since it contains more detail in the first section which perhaps we can transition into a more complete guide. Such a guide could also include upcoming JS APIs (cc @eugeneo) and the Advanced usage you mentioned. Let's keep working on that and submit PRs with suggested updates.

The doc in this PR is meant to be as short as possible and focus primarily on available tools per earlier feedback, to help users get started if they specify --inspect manually. In some ways it's a replacement for the chrome-devtools URL originally provided.

Also it's to engender conversation about how to make this experience as good as possible for users, so thanks for the feedback 😄

@ofrobots would be great to get more feedback and suggestions from the DevTools and Chromium teams, please make follow-on PRs and we can get them merged quickly. Thank you!

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

Successfully merging this pull request may close these issues.

4 participants