jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Prepend mdx files which used as includes with underscore to avoid creating and indexing pages from them

Browse Source 
Summary:
By default docusaurus generates pages and routes for every mdx file it finds under the root dir. So even for the mdx files which are only used as includes and don't even have headers, page is still created, then index and often looks very weird, e.g. title is the same as file name etc. See e.g. this one: https://www.internalfb.com/intern/staticdocs/flipper/docs/fb/portal-troubleshooting/

I went through Flipper docs and renamed all mdx files which are only used as includes to prepend them with underscore. Everything which name is starting with underscore, or which is inside a folder which name is starting with underscore is considered private by docusaurus and skipped.

Reviewed By: passy

Differential Revision: D32722547

fbshipit-source-id: 0524d4dd56960714fbdd2b01ad8383cd16de4948
This commit is contained in:
Anton Nikolaev
2021-11-30 13:24:46 -08:00
committed by Facebook GitHub Bot
parent bce1316743
commit ceba421997
6 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
desktop/plugins/public/network/docs/protobuf-retrofit.mdx → desktop/plugins/public/network/docs/_protobuf-retrofit.mdx
View File

2
desktop/plugins/public/network/docs/setup.mdx
View File

@@ -1,6 +1,6 @@
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
import ProtobufRetrofitSetup from './protobuf-retrofit.mdx'; import ProtobufRetrofitSetup from './_protobuf-retrofit.mdx';
To use the network plugin, you need to add the plugin to your Flipper client instance. To use the network plugin, you need to add the plugin to your Flipper client instance.

4
docs/extending/desktop-plugin-structure.mdx
View File

@@ -3,8 +3,8 @@ id: desktop-plugin-structure
title: Plugin structure title: Plugin structure
--- ---
import FbNpmDeps from '../fb/adding-npm-dependencies-0.mdx' import FbNpmDeps from '../fb/_adding-npm-dependencies-0.mdx'
import FbOnlyParts from '../fb/fb-only-parts-in-os-plugins.mdx' import FbOnlyParts from '../fb/_fb-only-parts-in-os-plugins.mdx'
Flipper Desktop plugins have a rigid structure. We recommend to scaffold any new plugin using our scaffolding tooling. Flipper Desktop plugins have a rigid structure. We recommend to scaffold any new plugin using our scaffolding tooling.

4
docs/extending/testing.mdx
View File

@@ -5,8 +5,8 @@ title: Testing
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
import FbIosTesting from '../fb/ios-plugin-development-testing-ios-plugins-0.mdx'; import FbIosTesting from '../fb/_ios-plugin-development-testing-ios-plugins-0.mdx';
import FbAndroidTesting from '../fb/android-plugin-development-testing-android-plugins-0.mdx'; import FbAndroidTesting from '../fb/_android-plugin-development-testing-android-plugins-0.mdx';
Developer tools are only used if they work. We have built APIs to test plugins. Developer tools are only used if they work. We have built APIs to test plugins.

2
docs/getting-started/index.mdx
View File

@@ -4,7 +4,7 @@ title: Desktop App
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl'; import useBaseUrl from '@docusaurus/useBaseUrl';
import FbInstallation from './fb/installation.mdx'; import FbInstallation from './fb/_installation.mdx';
Flipper helps you debug Android, iOS, and even web apps running in an emulator/simulator, connected physical development devices, or in your browser. Flipper consists of two parts: Flipper helps you debug Android, iOS, and even web apps running in an emulator/simulator, connected physical development devices, or in your browser. Flipper consists of two parts:

4
docs/troubleshooting.mdx
View File

@@ -6,9 +6,9 @@ custom_edit_url: https://www.internalfb.com/intern/diffusion/FBS/browsefile/mast
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl'; import useBaseUrl from '@docusaurus/useBaseUrl';
import InternalTroubleshooting from './fb/internal-troubleshooting.mdx'; import InternalTroubleshooting from './fb/_internal-troubleshooting.mdx';
import PortalTroubleshooting from './fb/portal-troubleshooting.mdx'; import PortalTroubleshooting from './fb/_portal-troubleshooting.mdx';
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.