From 083dbd3dbce8af3ea946c8be06a61cb38b53da6d Mon Sep 17 00:00:00 2001 From: John Knox Date: Wed, 9 Dec 2020 04:11:13 -0800 Subject: [PATCH] Merge troubleshooting pages Summary: This replaces the existing "FB Internals" troubleshooting" page with a redirect to the now single troubleshooting page, to make sure no links break. It copies the content of that internal page into an internal-troubleshooting.mdx file, that isn't in any sidebars. And it gets the main troubleshooting page to include that page, when doing an internal build. So now we only have one troubleshooting page. Reviewed By: passy Differential Revision: D25372552 fbshipit-source-id: 1a310ca1a4a21683d6074d480e819e5af40c8af2 --- docs/troubleshooting.mdx | 17 +++++++++++++++++ website/sidebars.js | 10 ++-------- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/troubleshooting.mdx b/docs/troubleshooting.mdx index 5c7a20058..0e37285aa 100644 --- a/docs/troubleshooting.mdx +++ b/docs/troubleshooting.mdx @@ -4,10 +4,23 @@ title: Troubleshooting Issues sidebar_label: Troubleshooting Issues --- import useBaseUrl from '@docusaurus/useBaseUrl'; + import Link from '@docusaurus/Link'; +import InternalTroubleshooting from './fb/internal-troubleshooting.mdx'; + +import {FbInternalOnly, OssOnly} from 'internaldocs-fb-helpers'; + 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. + + +## General Issues + + + + + ## Mac Desktop app ### Flipper won't launch on Mac @@ -33,6 +46,8 @@ We hope that flipper works well out of the box, but the software is a work in pr * Make sure the time and date are set correctly on your mobile device and desktop computer. * 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. @@ -47,6 +62,8 @@ This will only work if you added `FlipperDiagnosticActivity` to your `AndroidMan #### iOS You'll need to manually add this [ViewController](https://github.com/facebook/flipper/blob/master/iOS/FlipperKit/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 ([Tracking Issue](https://github.com/facebook/flipper/issues/262)). diff --git a/website/sidebars.js b/website/sidebars.js index cdd018ec2..a8b7ba6ab 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -75,14 +75,9 @@ module.exports = { 'extending/error-handling', 'extending/testing', 'extending/debugging', - ...fbInternalOnly([ - 'extending/fb/desktop-plugin-releases', - ]), - ], - 'Deprecated APIs': [ - 'extending/ui-components', - 'extending/js-plugin-api', + ...fbInternalOnly(['extending/fb/desktop-plugin-releases']), ], + 'Deprecated APIs': ['extending/ui-components', 'extending/js-plugin-api'], // end-internal-sidebars-example 'Other Platforms': [ 'extending/new-clients', @@ -97,7 +92,6 @@ module.exports = { }, 'fb-internal': { 'FB Internal': fbInternalOnly([ - 'fb/troubleshooting', 'fb/release-infra', 'fb/Add-flipper-to-android-app', 'fb/Adding-flipper-to-ios-app',