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.

Sign up for GitHub

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

Jump to bottom

Update Debugging docs to no longer recommend Remote debugging #3702

Merged
merged 2 commits into from
Jun 27, 2023
Merged

Update Debugging docs to no longer recommend Remote debugging #3702

merged 2 commits into from
Jun 27, 2023

Conversation

gabrieldonadel
Copy link
Contributor

Summary:

As a follow-up of facebook/react-native#36754, which removes the remote debugging option from the dev menu, this PR updates the Debugging documentation, deprecating Remote debugging and recommending the usage of Direct debugging with Safari as an alternative.

This also adds a quick section about Flipper as it currently is the hard-coded way of debugging when pressing Open Debugger

image

@netlify
Copy link

netlify bot commented Apr 25, 2023 •
edited
Loading

✅ Deploy Preview for react-native ready!

Name Link
🔨 Latest commit 0969e74
🔍 Latest deploy log https://app.netlify.com/sites/react-native/deploys/6447d1b845e4220008e69cd3
😎 Deploy Preview https://deploy-preview-3702--react-native.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@gabrieldonadel gabrieldonadel mentioned this pull request Apr 25, 2023
Closed
@kelset
Copy link
Contributor

kelset commented Apr 25, 2023

sidenote: this should not be merged until the PR referenced in merged and ported to 0.72 (if it will).

@Simek Simek added 🕐 Waiting on PR These may be waiting for a PR to the facebook/react-native to be merged Wait on future Release This indicates a PR that updates the doc to match a future release. labels Apr 25, 2023
@cortinico cortinico requested a review from huntie April 25, 2023 12:34
huntie
huntie requested changes Apr 25, 2023
View reviewed changes
Copy link
Member

@huntie huntie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gabrieldonadel! It's high time we documented Flipper! My main suggestion is not to remove what we have already around Chrome DevTools (instead inserting this deprecation notice under this section), and to change the documented timeline to 0.73.

The React Native team is actively re-evaluating our debugging options ahead of enabling the New Architecture by default. We are looking at replacement direct debugging approaches, and Chrome DevTools should very much remain part of the picture. (Plans may change.)

As such, happy to approve this (after feedback), to merge after 0.72 is out. We're likely to come back to this page and do a second pass once our plans are solidified for 0.73.

docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
docs/debugging.md Outdated Show resolved Hide resolved
@gabrieldonadel @huntie
Apply suggestions from code review
0969e74 
Co-authored-by: Alex Hunt <hello@alexhunt.io>
huntie
huntie approved these changes Apr 25, 2023
View reviewed changes
Copy link
Member

@huntie huntie left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Approving, tied to the result of facebook/react-native#36754 (still under evaluation).

I'm happy to document Flipper for the time being, as it's been the default JS debugging flow for a while. Including it represents the current state of things.

This PR is held by the Wait for future release label — and should be merged after the 0.72 docs are cut.

@gabrieldonadel gabrieldonadel mentioned this pull request Apr 28, 2023
Merged
3 tasks
@huntie huntie merged commit adb66d0 into facebook:main Jun 27, 2023
@gabrieldonadel gabrieldonadel deleted the update-debugging branch June 27, 2023 16:26
sunnylqm added a commit to reactnativecn/react-native-website that referenced this pull request Aug 5, 2023
@sunnylqm @gabrieldonadel
@huntie @dependabot @blakef @Pranav-yadav @waseemk7 @javache @cortinico @StefanWallin @Azelisi @NickGerleman @flexbox @slorber @connorpmullins @cipolleschi @Simek @kelset @stanleyugwu @duguyihou
0805 sync 0.73 (#734)
fe6e34b 
* Update Debugging docs to no longer recommend Remote debugging (facebook#3702)

Co-authored-by: Alex Hunt <hello@alexhunt.io>

* Bump fast-xml-parser from 4.2.4 to 4.2.5 (facebook#3777)

Bumps [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) from 4.2.4 to 4.2.5.
- [Release notes](https://github.com/NaturalIntelligence/fast-xml-parser/releases)
- [Changelog](https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/CHANGELOG.md)
- [Commits](NaturalIntelligence/fast-xml-parser@v4.2.4...v4.2.5)

---
updated-dependencies:
- dependency-name: fast-xml-parser
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Upgrade got dependency (facebook#3776)

* feature: Move to GA4 (UA being reprecated in June)

Google Analytics is deprecating the older clients. This is the first
step to enable to newer client. This should be followed with a step to
remove the old client once we know data is flowing.

* Upgrade got dependency

Resolves dependabot alerts #26

* Use `https` links over `http` (facebook#3761)

* [docs] Update/simplify info around Metro for env setup (facebook#3673)

* [docs] Add Metro guide, update Metro config references (facebook#3772)

* [docs] Remove static config note in Metro guide, adjust formatting (facebook#3782)

* Improving Grammar and Clarity.md (facebook#3783)

Improving Grammar and Clarity in React Native's Performance Description

* Fix docs for onResponderGrant (facebook#3785)

* react-native-gradle-plugin renamed to @react-native/gradle-plugin (facebook#3786)

* Update _integration-with-existing-apps-kotlin.md

* Update _integration-with-existing-apps-kotlin.md

* Update _integration-with-existing-apps-java.md

* Update _integration-with-existing-apps-java.md

* Update _integration-with-existing-apps-kotlin.md

* Update how-to-build-from-source for 0.72+ (facebook#3659)

* Clarify documentation for turbomodules (facebook#3787)

* Clarify documentation for turbomodules

`codegenConfig` is stated in text that it's an array, but in code example it's an object.

Either the text or the code example should change.

* Fix linting issue

* Update the PR to reflect knowledge that the code sample is correct but documentation wrong

* Update FlatList Optimization Guide for FCs (facebook#3700)

* Update FlatList Optimization Guide for FCs

* fix lint

* Update docs/optimizing-flatlist-configuration.md

---------

Co-authored-by: Егорик <86266852+Huinko@users.noreply.github.com>
Co-authored-by: Nick Gerleman <nick@nickgerleman.com>

* [docs] Add guidance on repo build scripts (facebook#3788)

* [docs] add Chain React 2023 playlist link on staying-updated (facebook#3790)

* Bump semver from 5.7.1 to 5.7.2 (facebook#3791)

Bumps [semver](https://github.com/npm/node-semver) from 5.7.1 to 5.7.2.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/v5.7.2/CHANGELOG.md)
- [Commits](npm/node-semver@v5.7.1...v5.7.2)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Docusaurus v2.4.1 (facebook#3778)

* Bump word-wrap from 1.2.3 to 1.2.4 (facebook#3794)

Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](jonschlinkert/word-wrap@1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: iOS backwards compatibility update (facebook#3775)

* Update backward-compatibility-fabric-components.md

Ensure backwards-compat docs refer to all necessary code changes.

reactwg/react-native-new-architecture#8 (comment)

* Update docs/the-new-architecture/backward-compatibility-fabric-components.md

Co-authored-by: Riccardo Cipolleschi <riccardo.cipolleschi@gmail.com>

* trim whitespace and fix typo

---------

Co-authored-by: Riccardo Cipolleschi <riccardo.cipolleschi@gmail.com>

* [website] swizzle DocVersionBanner, tweak wording (facebook#3800)

* tweak: improve wordiness on docs about bumping monorepo packages (facebook#3805)

* Fix typo in architecture-glossary.md (facebook#3806)

* docs: change js to tsx (facebook#3808)

* Update website to use JDK 17 (facebook#3812)

LGTM.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Gabriel Donadel Dall'Agnol <donadeldev@gmail.com>
Co-authored-by: Alex Hunt <hello@alexhunt.io>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Blake Friedman <blakef@meta.com>
Co-authored-by: Pranav Yadav <Pranavyadav3912@gmail.com>
Co-authored-by: Waseem Kurne <55435990+waseemk7@users.noreply.github.com>
Co-authored-by: Pieter De Baets <pieterdb@meta.com>
Co-authored-by: Nicola Corti <corti.nico@gmail.com>
Co-authored-by: Stefan Wallin <github@stefan-wallin.se>
Co-authored-by: Егорик <86266852+Azelisi@users.noreply.github.com>
Co-authored-by: Егорик <86266852+Huinko@users.noreply.github.com>
Co-authored-by: Nick Gerleman <nick@nickgerleman.com>
Co-authored-by: David Leuliette <dleuliette@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Connor Mullins <connorpmullins@gmail.com>
Co-authored-by: Riccardo Cipolleschi <riccardo.cipolleschi@gmail.com>
Co-authored-by: Bartosz Kaszubowski <gosimek@gmail.com>
Co-authored-by: Lorenzo Sciandra <lsciandra@microsoft.com>
Co-authored-by: Stanley Ugwu <stanleyugwu2018@gmail.com>
Co-authored-by: kong <duguyihou@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@huntie huntie huntie approved these changes

Assignees
No one assigned
Labels
CLA Signed 🕐 Waiting on PR These may be waiting for a PR to the facebook/react-native to be merged p: expo Partner Wait on future Release This indicates a PR that updates the doc to match a future release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gabrieldonadel @kelset @huntie @Simek @facebook-github-bot