From 11688f2f11c27bd46301eb9c601050361881d6a3 Mon Sep 17 00:00:00 2001 From: Kevin Strider Date: Thu, 24 Nov 2022 05:41:07 -0800 Subject: [PATCH] Setup - Part 1 Summary: This diff includes minor changes to the pages within the Setup section of Flipper Docs. Reviewed By: passy Differential Revision: D41472932 fbshipit-source-id: 41894bba63a91e90869423af1d3635ac3fa0c20f --- docs/getting-started/index.mdx | 4 ++-- docs/getting-started/troubleshooting/android.mdx | 16 ++++------------ docs/getting-started/troubleshooting/general.mdx | 4 ++-- docs/getting-started/troubleshooting/ios.mdx | 11 +++++------ .../troubleshooting/react-native.mdx | 2 +- .../troubleshooting/troubleshooting.mdx | 6 +++--- 6 files changed, 17 insertions(+), 26 deletions(-) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 4f0555f24..adae1c894 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -55,5 +55,5 @@ If you are hacking a JS app, you should be good to go without any extra dependen ## Troubleshooting -If you run into problems, take a look at the [troubleshooting](troubleshooting/troubleshooting.mdx) section. -Failing that, check [GitHub Issues](https://github.com/facebook/flipper/issues).the [Workplace group](https://fb.workplace.com/groups/230455004101832/). +If you run into problems, take a look at the [Troubleshooting](troubleshooting/troubleshooting.mdx) section. +Failing that, have a look at [GitHub Issues](https://github.com/facebook/flipper/issues).the [Flipper Support](https://fb.workplace.com/groups/230455004101832/). diff --git a/docs/getting-started/troubleshooting/android.mdx b/docs/getting-started/troubleshooting/android.mdx index bed074025..cc75c42b1 100644 --- a/docs/getting-started/troubleshooting/android.mdx +++ b/docs/getting-started/troubleshooting/android.mdx @@ -7,7 +7,7 @@ custom_edit_url: https://www.internalfb.com/intern/diffusion/FBS/browsefile/mast import InternalAndroid from './fb/_android.mdx'; -Flipper is a work in progress and issues may occur. This page contains known issues associated with the Android platform and provides steps you can take to try to resolve them. +Flipper is a 'work in progress' and issues may occur. This page contains known issues associated with the Android platform and provides steps you can take to try to resolve them. @@ -61,19 +61,11 @@ debugImplementation('com.facebook.flipper:flipper:*') { ## Duplicate class `com.facebook.jni.*` -This can occur when mixing different versions of [FBJNI](https://github.com/facebookincubator/fbjni), -a library we use to interact with native C++ code. +This can occur when mixing different versions of [FBJNI](https://github.com/facebookincubator/fbjni), a library we use to interact with native C++ code. -Speficially, this can happen when the versions `0.0.x` and `0.1.x` are mixed. Version `0.1.0` of FBJNI -switched to using [Google Prefab](https://google.github.io/prefab/) for distributing native artifacts, -which made the split into combined, "java-only" and "header" packages redundant and only requires -a single dependency in your projects. +Speficially, this can happen when the versions `0.0.x` and `0.1.x` are mixed. Version `0.1.0` of FBJNI switched to using [Google Prefab](https://google.github.io/prefab/) for distributing native artifacts, which made the split into combined, "java-only" and "header" packages redundant and only requires a single dependency in your projects. -When including both "fbjni-java-only:0.0.1" and "fbjni:0.1.0" in one project, you will now -duplicate class errors during the build process. You must ensure that only one of the two -versions is used in your entire dependency tree. Start by looking at `./gradlew :myapp:dependencies` -to see where the different version requirements come from. Then exclude the FBJNI dependency from -one of them, e.g. +When including both "fbjni-java-only:0.0.1" and "fbjni:0.1.0" in one project, you will now duplicate class errors during the build process. You must ensure that only one of the two versions is used in your entire dependency tree. Start by looking at `./gradlew :myapp:dependencies` to see where the different version requirements come from. Then exclude the FBJNI dependency from one of them, as follows: ```groovy implementation("com.facebook.react:react-native:+") { diff --git a/docs/getting-started/troubleshooting/general.mdx b/docs/getting-started/troubleshooting/general.mdx index 56fb5c2c4..d6f7a231f 100644 --- a/docs/getting-started/troubleshooting/general.mdx +++ b/docs/getting-started/troubleshooting/general.mdx @@ -7,7 +7,7 @@ custom_edit_url: https://www.internalfb.com/intern/diffusion/FBS/browsefile/mast import InternalGeneral from './fb/_general.mdx'; -Flipper is a work in progress and issues may occur. This page contains known issues associated with the Mac desktop apps and provides steps you can take to try to resolve them. +Flipper is a 'work in progress' and issues may occur. This page mostly contains general issues associated with the Mac desktop apps (Android is mentioned) and provides steps you can take to try to resolve them. @@ -50,4 +50,4 @@ can do this in Android Studio using the [Virtual Device Manager](https://develop For **iOS**, after installing Xcode, you should have a default set of simulators set up. However, it is possible to delete them and there is no easy way to restore them afterwards. You can use [a script like this one](https://gist.github.com/dynamicguy/e8756a9f0f50af86d6e746d4b1ab6a09) to -recreate the default set. \ No newline at end of file +recreate the default set. diff --git a/docs/getting-started/troubleshooting/ios.mdx b/docs/getting-started/troubleshooting/ios.mdx index d75b6cc0f..c45b0c293 100644 --- a/docs/getting-started/troubleshooting/ios.mdx +++ b/docs/getting-started/troubleshooting/ios.mdx @@ -5,6 +5,8 @@ sidebar_label: iOS Issues custom_edit_url: https://www.internalfb.com/intern/diffusion/FBS/browsefile/master/xplat/sonar/docs/getting-started/troubleshooting/ios.mdx --- +Flipper is a 'work in progress' and issues may occur. This page contains known issues associated with the iOS platform and provides steps you can take to try to resolve them. + import InternalIos from './fb/_ios.mdx'; @@ -17,17 +19,14 @@ You'll need to manually add this [ViewController](https://github.com/facebook/fl ## iOS device not showing up -- Make sure [`idb`](https://fbidb.io/docs/installation) is installed and configured in the Flipper settings. +Make sure [idb](https://fbidb.io/docs/installation) is installed and configured in the Flipper settings. ## iOS simulator device not showing up -Ensure that your simulator is on the same version as selected in `xcode-select`. -You can do that by checking that commands `ps aux | grep CoreSimulator` and `xcode-select -p` shows the same Xcode version. -If not, update the xcode version by sudo `xcode-select --switch ` +Ensure that your simulator is on the same version as selected in `xcode-select`. You can do that by checking that commands `ps aux | grep CoreSimulator` and `xcode-select -p` shows the same Xcode version. If not, update the xcode version by sudo `xcode-select --switch ` ## iOS app connection error "Connection failed. Failed to find device..." -If during connecting iOS app to Flipper you see error message "Connection failed. Failed to find device while trying to connect app" - -try executing `idb kill` on a terminal and restarting Flipper as workaround to reset idb state. +If during connecting iOS app to Flipper you see error message "Connection failed. Failed to find device while trying to connect app" - try executing `idb kill` on a terminal and restarting Flipper as workaround to reset idb state. diff --git a/docs/getting-started/troubleshooting/react-native.mdx b/docs/getting-started/troubleshooting/react-native.mdx index 45eee1b7f..26083aaa7 100644 --- a/docs/getting-started/troubleshooting/react-native.mdx +++ b/docs/getting-started/troubleshooting/react-native.mdx @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; import InternalReactNative from './fb/_react-native.mdx'; -Flipper is a work in progress and issues may occur. This page contains known issues associated with React Native and provides steps you can take to try to resolve them. +Flipper is a 'work in progress' and issues may occur. This page contains known issues associated with React Native and provides steps you can take to try to resolve them. Make sure the project is using the [latest Flipper SDK](getting-started/react-native.mdx#using-the-latest-flipper-sdk). diff --git a/docs/getting-started/troubleshooting/troubleshooting.mdx b/docs/getting-started/troubleshooting/troubleshooting.mdx index 341062eb3..c3566d7c3 100644 --- a/docs/getting-started/troubleshooting/troubleshooting.mdx +++ b/docs/getting-started/troubleshooting/troubleshooting.mdx @@ -7,15 +7,15 @@ custom_edit_url: https://www.internalfb.com/intern/diffusion/FBS/browsefile/mast import InternalTroubleshooting from './fb/_troubleshooting.mdx'; -Flipper is a work in progress and, as such, there's a chance that issues may occur while you're using it. +Flipper is a 'work in progress' and, as such, there's a chance that issues may occur while you're using it. -The 'troubleshooting' section contains known issues that have occurred within various Flipper environments and the steps you can take if you encounter them. +This 'troubleshooting' section contains known issues that have occurred within various Flipper environments and the steps you can take if you encounter them. ## How to file an issue or ask a question? -If you are still blocked after checking Troubleshooting guide you may file an issue on [GitHub](https://github.com/facebook/flipper/issues) +If you are still blocked after checking Troubleshooting guide you may file an issue on [GitHub](https://github.com/facebook/flipper/issues) with the chrome DevTools logs and the output from the diagnostics screen, if relevant.