From 00356f96c55ba03429eb918f917333384e151a30 Mon Sep 17 00:00:00 2001 From: John Knox Date: Wed, 16 Dec 2020 10:35:34 -0800 Subject: [PATCH] Convert Link tags to md syntax Summary: Previously we used everywhere with useBaseUrl to avoid link destinations depending on the current url of the page. This isn't necessary if you instead link to the **file name**, rather than the **url path**. Then the links are resolved at build time, and work across imported markdown files etc. This diff just does the pages under Features, because other ones will get conflicts. I'll do those later. Reviewed By: nikoant Differential Revision: D25589707 fbshipit-source-id: 35ca986e19fc2af1054b81d7253eeb3827947ab8 --- docs/features/crash-reporter-plugin.mdx | 3 +-- docs/features/databases-plugin.mdx | 3 +-- docs/features/images-plugin.mdx | 3 +-- docs/features/index.mdx | 3 +-- docs/features/layout-plugin.mdx | 3 +-- docs/features/leak-canary-plugin.mdx | 3 +-- docs/features/navigation-plugin.mdx | 3 +-- docs/features/network-plugin.mdx | 3 +-- docs/features/react-native.mdx | 7 +++---- docs/features/sandbox-plugin.mdx | 3 +-- docs/features/shared-preferences-plugin.mdx | 3 +-- docs/troubleshooting.mdx | 4 +--- 12 files changed, 14 insertions(+), 27 deletions(-) diff --git a/docs/features/crash-reporter-plugin.mdx b/docs/features/crash-reporter-plugin.mdx index 616291e84..db5f2a2c4 100644 --- a/docs/features/crash-reporter-plugin.mdx +++ b/docs/features/crash-reporter-plugin.mdx @@ -3,9 +3,8 @@ id: crash-reporter-plugin title: Crash Reporter --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Crash Reporter +→ [See setup instructions for the Crash Reporter](../setup/crash-reporter-plugin.mdx) The Crash Reporter Plugin shows a notification in Flipper whenever an app crashes. You can click on the notification to see crash information like stacktrace and other metadata. For Android, you can click the "Open in Logs" button to jump to the row in the Logs plugin with the crash information. diff --git a/docs/features/databases-plugin.mdx b/docs/features/databases-plugin.mdx index a633b8a63..cccfb2763 100644 --- a/docs/features/databases-plugin.mdx +++ b/docs/features/databases-plugin.mdx @@ -3,9 +3,8 @@ id: databases-plugin title: Databases --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Databases plugin +→ [See setup instructions for the Databases plugin](../setup/databases-plugin.mdx) The Databases plugin provides developers with read-write access to their databases: - browse your tables' data diff --git a/docs/features/images-plugin.mdx b/docs/features/images-plugin.mdx index 388b20ca9..917a019c6 100644 --- a/docs/features/images-plugin.mdx +++ b/docs/features/images-plugin.mdx @@ -3,9 +3,8 @@ id: images-plugin title: Images --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the images plugin +→ [See setup instructions for the images plugin](../setup/images-plugin.mdx) The images plugin allows you to inspect what images were fetched, where they are coming from and selectively clear caches. Currently, the plugin supports diff --git a/docs/features/index.mdx b/docs/features/index.mdx index c5d2e0e10..8563bd76d 100644 --- a/docs/features/index.mdx +++ b/docs/features/index.mdx @@ -3,7 +3,6 @@ id: index title: Features --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; Flipper itself only provides the architectural platform. What makes it useful are the plugins built on top of it: [Logs](logs-plugin), [Layout Inspector](layout-plugin) and [Network Inspector](network-plugin) are all plugins. Plugins can be built very specific to your business logic and the use-cases you have in your app. We are shipping Flipper with a couple of built-in all-purpose plugins, but we encourage you to build your own. Each plugin needs to be enabled individually. @@ -13,4 +12,4 @@ Flipper itself only provides the architectural platform. What makes it useful ar The Flipper desktop app and the mobile native SDK establish a connection which is used to send data to and from the device. Flipper does not make any restrictions on what kind of data is being sent. This enables a lot of different use-cases where you want to better understand what is going inside your app. For example you can visualize the state of local caches, events happening or trigger actions on your app from the desktop. -If there is no plugin that does exactly what you want, you can build your own plugin, tailored to your needs. A plugin always consists of the native implementation sending and receiving data and the desktop plugin visualizing data. Learn more on how to extend Flipper and build your own plugin. The native implementations are written in Java, Objective-C, or C++, the desktop UI is written in React. +If there is no plugin that does exactly what you want, you can build your own plugin, tailored to your needs. A plugin always consists of the native implementation sending and receiving data and the desktop plugin visualizing data. Learn more on how to [extend Flipper](../extending/index.mdx) and build your own plugin. The native implementations are written in Java, Objective-C, or C++, the desktop UI is written in React. diff --git a/docs/features/layout-plugin.mdx b/docs/features/layout-plugin.mdx index 990dfcad8..d02e6ad47 100644 --- a/docs/features/layout-plugin.mdx +++ b/docs/features/layout-plugin.mdx @@ -3,9 +3,8 @@ id: layout-plugin title: Layout Inspector --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Layout Inspector +→ [See setup instructions for the Layout Inspector](../setup/layout-plugin.mdx) The Layout Inspector in Flipper is useful for a ton of different debugging scenarios. First of all, you can inspect what views the hierarchy is made up of as well as what properties each view has. This is incredibly useful when debugging issues with your product. diff --git a/docs/features/leak-canary-plugin.mdx b/docs/features/leak-canary-plugin.mdx index 03ae2f129..2dea5c65e 100644 --- a/docs/features/leak-canary-plugin.mdx +++ b/docs/features/leak-canary-plugin.mdx @@ -3,9 +3,8 @@ id: leak-canary-plugin title: LeakCanary --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the LeakCanary +→ [See setup instructions for the LeakCanary](../setup/leak-canary-plugin.mdx) The LeakCanary plugin provides developers with Flipper support for [LeakCanary](https://github.com/square/leakcanary), an open source memory leak detection library. diff --git a/docs/features/navigation-plugin.mdx b/docs/features/navigation-plugin.mdx index 3c9be11fb..de24d6a92 100644 --- a/docs/features/navigation-plugin.mdx +++ b/docs/features/navigation-plugin.mdx @@ -3,9 +3,8 @@ id: navigation-plugin title: Navigation --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Navigation Plugin +→ [See setup instructions for the Navigation Plugin](../setup/navigation-plugin.mdx) The Navigation Plugin allows users to quickly navigate to deep links within their mobile applications to help speed up the development cycle. The plugin is designed to integrate easily within your existing navigation framework or as a stand alone tool. Users can bookmark deep links and jump to them via the button in the tool bar. diff --git a/docs/features/network-plugin.mdx b/docs/features/network-plugin.mdx index 1ce84b65c..077262ad2 100644 --- a/docs/features/network-plugin.mdx +++ b/docs/features/network-plugin.mdx @@ -3,9 +3,8 @@ id: network-plugin title: Network --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Network plugin +→ [See setup instructions for the Network plugin](../setup/network-plugin.mdx) Use the Network inspector to inspect outgoing network traffic in your apps. You can easily browse all requests being made and their responses. The plugin also supports gzipped responses. diff --git a/docs/features/react-native.mdx b/docs/features/react-native.mdx index 63f8eb62f..524f891e8 100644 --- a/docs/features/react-native.mdx +++ b/docs/features/react-native.mdx @@ -3,14 +3,13 @@ id: react-native title: React Native Support --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; React Native + React DevTools The React Native and Developer tooling teams at Facebook work in close collaboration to make sure Flipper offers top-notch value out of the box for React Native development. Integration between React Native and Flipper is enabled out of the box in React Native version 0.62 and higher. -→ See setup instructions for React Native +→ [See setup instructions for React Native](../getting-started/index.mdx#setup-your-react-native-app)
@@ -52,8 +51,8 @@ _Example Flipper plugin: playing a game of Tic Tac Toe using Flipper and some em If you would love to build a specific (or generic) extension for Flipper check out the following pointers! Plugins for Flipper can be distributed through NPM so sharing them is trivial. -* Creating a React Native Flipper Plugin -* Create a Flipper Desktop Plugin +* [Creating a React Native Flipper Plugin](../tutorial/react-native.mdx) +* [Create a Flipper Desktop Plugin](../tutorial/js-setup.mdx) ### Community React Native plugins for Flipper diff --git a/docs/features/sandbox-plugin.mdx b/docs/features/sandbox-plugin.mdx index e2127406f..8fca04058 100644 --- a/docs/features/sandbox-plugin.mdx +++ b/docs/features/sandbox-plugin.mdx @@ -3,8 +3,7 @@ id: sandbox-plugin title: Sandbox --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Sandbox plugin +→ [See setup instructions for the Sandbox plugin](../setup/sandbox-plugin.mdx) The sandbox plugin allows developers to test changes in their apps by pointing them to a sandbox environment. It provides a simple UI to set and modify the URL to a development host that acts as a sandbox directly on the desktop, which prevents you from entering potentially long and complicated URL inside your app. diff --git a/docs/features/shared-preferences-plugin.mdx b/docs/features/shared-preferences-plugin.mdx index da1ba5934..517357eee 100644 --- a/docs/features/shared-preferences-plugin.mdx +++ b/docs/features/shared-preferences-plugin.mdx @@ -3,9 +3,8 @@ id: shared-preferences-plugin title: Shared Preferences --- import useBaseUrl from '@docusaurus/useBaseUrl'; -import Link from '@docusaurus/Link'; -→ See setup instructions for the Shared Preferences plugin +→ [See setup instructions for the Shared Preferences plugin](../setup/shared-preferences-plugin.mdx) Easily inspect and modify the data contained within your app's shared preferences. diff --git a/docs/troubleshooting.mdx b/docs/troubleshooting.mdx index 0e37285aa..13e252ae4 100644 --- a/docs/troubleshooting.mdx +++ b/docs/troubleshooting.mdx @@ -5,8 +5,6 @@ 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'; @@ -57,7 +55,7 @@ On a terminal, run the following: ```bash adb shell am start -n /com.facebook.flipper.android.diagnostics.FlipperDiagnosticActivity ``` -This will only work if you added `FlipperDiagnosticActivity` to your `AndroidManifest.xml`. See getting started for help. +This will only work if you added `FlipperDiagnosticActivity` to your `AndroidManifest.xml`. See [getting started](./getting-started/android-native.mdx#diagnostics) for help. #### 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.