From 01dc8ed6fd93442c59c4c97ae0d96f5711b4d26c Mon Sep 17 00:00:00 2001 From: John Knox Date: Fri, 14 Sep 2018 04:47:12 -0700 Subject: [PATCH] Add troubleshooting page Summary: Adds a bunch of steps to take if you're having trouble. Reviewed By: danielbuechele Differential Revision: D9811295 fbshipit-source-id: 6802108e98850ab11764081491a528eb939d2224 --- docs/getting-started.md | 4 +++ docs/troubleshooting.md | 54 +++++++++++++++++++++++++++++++++++++++++ website/i18n/en.json | 2 ++ website/sidebars.json | 2 +- 4 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 docs/troubleshooting.md diff --git a/docs/getting-started.md b/docs/getting-started.md index 140139a54..f442d1d7b 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -149,3 +149,7 @@ and install the dependencies by running `pod install`. When you open the Xcode w ## Ready for takeoff Finally, you need to add plugins to your Flipper client. Above we have only added the Layout Inspector plugin to get you started. See [Network Plugin](network-plugin.md) and [Layout Inspector Plugin](layout-plugin.md) for information on how to add them, and also enable Litho or ComponentKit support. You can check the sample apps in the [GitHub repo](https://github.com/facebook/flipper) for examples of integrating other plugins. + +## Having trouble? + +See the [troubleshooting page](troubleshooting.html) for help with known problems. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 000000000..bca9c601a --- /dev/null +++ b/docs/troubleshooting.md @@ -0,0 +1,54 @@ +--- +id: troubleshooting +title: Troubleshooting Issues +sidebar_label: Troubleshooting Issues +--- + +We hope that flipper works well out of the box, but the software is a work in progress and problems will occur. Below are some known issues and steps you can take to try to resolve them. + +## Desktop app + +### Flipper won't launch + +* If the window is appearing, try opening Chrome dev tools within Flipper. To do so, from the View menu select Toggle Developer Tools or press CMD+Option+I and check if there are any errors on the console. +* Launch Flipper from the command line using `/Applications/Flipper.app/Contents/MacOS/Flipper` This should give you some logs, that might be helpful when debugging. +* Delete `~/.flipper` and try relaunching Flipper +* Delete Flipper from your applications folder and redownload [Flipper](https://www.facebook.com/fbflipper/public/mac) +* If you're using `yarn start` to run from source, make sure all dependencies are installed correctly by running yarn install + +### iOS Simulator missing from devices dropdown + +* Check that `xcode-select -p` shows the same xcode version that you're using. If not, see xcode-select for how to select the correct version. + +### No plugins showing up for your device + +* Check your device isn't on the list of [known incompatibilities](#known-incompatibilities) +* Make sure your version of Flipper is up to date. +* Make sure the mobile SDK you are using is relatively recent (<1 month old). +* Open Chrome dev tools within Flipper. To do so, from the View menu select Toggle Developer Tools or press CMD+Option+I and check if there are any errors on the console. +* Delete `~/.flipper` +* **Uninstall** and reinstall the mobile app. +* If no app plugins are showing up, there may be a connectivity issue between Flipper and your app. Check [connection issues](#connection-issues) to see if anything is failing. + +### Connection Issues +The Flipper SDK includes an in-app connection diagnostics screen to help you diagnose problems. + +#### Android +Replace `` below with the package name of your app, e.g. `com.facebook.flipper.sample`. +On a terminal, run the following: +```bash +adb shell am start -n /com.facebook.sonar.android.diagnostics.SonarDiagnosticActivity +``` +This will only work if you added `SonarDiagnosticActivity` to your `AndroidManifest.xml`. See [getting started](getting-started.html) for help. + +#### iOS +You'll need to manually add this [ViewController](https://github.com/facebook/flipper/blob/master/iOS/SonarKit/FlipperDiagnosticsViewController.m) to your app to see the in-app diagnostics. + +### Known Incompatibilities +The following devices are known to be incompatible or face issues with flipper: +* Physical iOS devices. Currently on iOS, only simulators are supported. [GitHub Issue](https://github.com/facebook/flipper/issues/262) +* Some Samsung devices. [GitHub Issue](https://github.com/facebook/flipper/issues/92) +* Genymotion emulators on Android 8+ are reported to have issues. + +### File an Issue +Still not working? File an issue on [GitHub](https://github.com/facebook/flipper) with the chrome dev tools logs and the output from the diagnostics screen, if relevant. diff --git a/website/i18n/en.json b/website/i18n/en.json index 5b7d78040..518a2f8c2 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -32,6 +32,8 @@ "Styling Components": "Styling Components", "testing": "Testing", "Testing": "Testing", + "troubleshooting": "Troubleshooting Issues", + "Troubleshooting Issues": "Troubleshooting Issues", "ui-components": "UI Components", "UI Components": "UI Components", "understand": "Understanding Flipper", diff --git a/website/sidebars.json b/website/sidebars.json index 5e2e8d9ae..73668d126 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -1,6 +1,6 @@ { "docs": { - "Using Flipper": ["getting-started", "understand", "stetho"], + "Using Flipper": ["getting-started", "understand", "stetho", "troubleshooting"], "Built-in Plugins": [ "logs-plugin", "layout-plugin",