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
This commit is contained in:
John Knox
2020-12-09 04:11:13 -08:00
committed by Facebook GitHub Bot
parent 92f6e85bf6
commit 083dbd3dbc
2 changed files with 19 additions and 8 deletions

View File

@@ -4,10 +4,23 @@ title: Troubleshooting Issues
sidebar_label: Troubleshooting Issues sidebar_label: Troubleshooting Issues
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl'; import useBaseUrl from '@docusaurus/useBaseUrl';
import Link from '@docusaurus/Link'; 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. 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.
<FbInternalOnly>
## General Issues
<InternalTroubleshooting />
</FbInternalOnly>
## Mac Desktop app ## Mac Desktop app
### Flipper won't launch on Mac ### 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. * 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. * 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.
<OssOnly>
### Connection Issues ### Connection Issues
The Flipper SDK includes an in-app connection diagnostics screen to help you diagnose problems. 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 #### 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. 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.
</OssOnly>
### Known Incompatibilities ### Known Incompatibilities
The following devices are known to be incompatible or face issues with flipper: 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)). * Physical iOS devices. Currently on iOS, only simulators are supported ([Tracking Issue](https://github.com/facebook/flipper/issues/262)).

View File

@@ -75,14 +75,9 @@ module.exports = {
'extending/error-handling', 'extending/error-handling',
'extending/testing', 'extending/testing',
'extending/debugging', 'extending/debugging',
...fbInternalOnly([ ...fbInternalOnly(['extending/fb/desktop-plugin-releases']),
'extending/fb/desktop-plugin-releases',
]),
],
'Deprecated APIs': [
'extending/ui-components',
'extending/js-plugin-api',
], ],
'Deprecated APIs': ['extending/ui-components', 'extending/js-plugin-api'],
// end-internal-sidebars-example // end-internal-sidebars-example
'Other Platforms': [ 'Other Platforms': [
'extending/new-clients', 'extending/new-clients',
@@ -97,7 +92,6 @@ module.exports = {
}, },
'fb-internal': { 'fb-internal': {
'FB Internal': fbInternalOnly([ 'FB Internal': fbInternalOnly([
'fb/troubleshooting',
'fb/release-infra', 'fb/release-infra',
'fb/Add-flipper-to-android-app', 'fb/Add-flipper-to-android-app',
'fb/Adding-flipper-to-ios-app', 'fb/Adding-flipper-to-ios-app',