Import internal pages from wiki
Summary: This is the unadulterated output from running: `yarn start static-docs-from-wiki --wiki_name Flipper --site_dir xplat/sonar/website` Reviewed By: passy Differential Revision: D23241773 fbshipit-source-id: 136e99130c77bedfb66bb31e31a7b331278857bb
This commit is contained in:
committed by
Facebook GitHub Bot
parent
4228e0dd26
commit
c6569470f4
@@ -6,17 +6,18 @@
|
|||||||
*
|
*
|
||||||
* @format
|
* @format
|
||||||
*/
|
*/
|
||||||
|
|
||||||
function FBInternalWithOssFallback(elements, fallback) {
|
function FBInternalWithOssFallback(elements, fallback) {
|
||||||
return process.env.FB_INTERNAL ? elements : fallback;
|
return process.env.FB_INTERNAL ? elements : fallback;
|
||||||
}
|
}
|
||||||
|
|
||||||
const repoUrl = 'https://github.com/facebook/flipper';
|
const repoUrl = 'https://github.com/facebook/flipper';
|
||||||
|
|
||||||
const siteConfig = {
|
const siteConfig = {
|
||||||
title: FBInternalWithOssFallback('Flipper @FB', 'Flipper'),
|
title: FBInternalWithOssFallback('Flipper @FB', 'Flipper'),
|
||||||
tagline: 'Extensible mobile app debugging',
|
tagline: 'Extensible mobile app debugging',
|
||||||
url: FBInternalWithOssFallback('https://flipper.thefacebook.com/', 'https://fbflipper.com/'),
|
url: FBInternalWithOssFallback(
|
||||||
|
'https://flipper.thefacebook.com/',
|
||||||
|
'https://fbflipper.com/',
|
||||||
|
),
|
||||||
baseUrl: '/',
|
baseUrl: '/',
|
||||||
projectName: 'flipper',
|
projectName: 'flipper',
|
||||||
// TODO: T69061026 enable once sandy docs are complete: external_domain: 'fbflipper.com',
|
// TODO: T69061026 enable once sandy docs are complete: external_domain: 'fbflipper.com',
|
||||||
@@ -28,10 +29,33 @@ const siteConfig = {
|
|||||||
src: 'img/icon.png',
|
src: 'img/icon.png',
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
{to: 'docs/features/index', label: 'Features', position: 'right'},
|
{
|
||||||
{to: 'docs/getting-started/index', label: 'Setup', position: 'right'},
|
to: 'docs/features/index',
|
||||||
{to: 'docs/extending/index', label: 'Extending', position: 'right'},
|
label: 'Features',
|
||||||
{href: repoUrl, label: 'GitHub', position: 'right'},
|
position: 'right',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
to: 'docs/getting-started/index',
|
||||||
|
label: 'Setup',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
to: 'docs/extending/index',
|
||||||
|
label: 'Extending',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: repoUrl,
|
||||||
|
label: 'GitHub',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
...FBInternalOnly([
|
||||||
|
{
|
||||||
|
to: 'docs/fb/index',
|
||||||
|
label: 'FB Internal',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
]),
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
colorMode: {
|
colorMode: {
|
||||||
@@ -46,14 +70,23 @@ const siteConfig = {
|
|||||||
{
|
{
|
||||||
title: 'Learn',
|
title: 'Learn',
|
||||||
items: [
|
items: [
|
||||||
{label: 'Getting Started', to: 'docs/getting-started/index'},
|
{
|
||||||
{label: 'Plugin Creation Tutorial', to: 'docs/tutorial/intro'},
|
label: 'Getting Started',
|
||||||
|
to: 'docs/getting-started/index',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Plugin Creation Tutorial',
|
||||||
|
to: 'docs/tutorial/intro',
|
||||||
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'Plugins',
|
title: 'Plugins',
|
||||||
items: [
|
items: [
|
||||||
{label: 'Core Plugins', to: 'docs/features/index'},
|
{
|
||||||
|
label: 'Core Plugins',
|
||||||
|
to: 'docs/features/index',
|
||||||
|
},
|
||||||
{
|
{
|
||||||
label: 'Community Plugins',
|
label: 'Community Plugins',
|
||||||
href: 'https://www.npmjs.com/search?q=keywords:flipper-plugin',
|
href: 'https://www.npmjs.com/search?q=keywords:flipper-plugin',
|
||||||
@@ -77,10 +110,16 @@ const siteConfig = {
|
|||||||
{
|
{
|
||||||
title: 'More',
|
title: 'More',
|
||||||
items: [
|
items: [
|
||||||
{label: 'Twitter', href: 'https://twitter.com/flipper_fb'},
|
{
|
||||||
{label: 'GitHub', href: repoUrl},
|
label: 'Twitter',
|
||||||
|
href: 'https://twitter.com/flipper_fb',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'GitHub',
|
||||||
|
href: repoUrl,
|
||||||
|
},
|
||||||
],
|
],
|
||||||
}
|
},
|
||||||
],
|
],
|
||||||
copyright: 'Copyright © ' + new Date().getFullYear() + ' Facebook',
|
copyright: 'Copyright © ' + new Date().getFullYear() + ' Facebook',
|
||||||
logo: {
|
logo: {
|
||||||
@@ -127,4 +166,8 @@ const siteConfig = {
|
|||||||
],
|
],
|
||||||
};
|
};
|
||||||
|
|
||||||
|
function FBInternalOnly(elements, fallback) {
|
||||||
|
return process.env.FB_INTERNAL == 1 ? elements : fallback || [];
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = siteConfig;
|
module.exports = siteConfig;
|
||||||
|
|||||||
@@ -7,108 +7,135 @@
|
|||||||
* @format
|
* @format
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Adds content only if building internal FB version of documentations
|
Adds content only if building internal FB version of documentations
|
||||||
e.g. ...FBInternalOnly({'sected-id'})
|
e.g. ...FBInternalOnly({'sected-id'})
|
||||||
*/
|
*/
|
||||||
function FBInternalOnly(elements) {
|
|
||||||
return process.env.FB_INTERNAL ? elements : [];
|
|
||||||
}
|
|
||||||
|
|
||||||
function NotInFBInternal(elements) {
|
function NotInFBInternal(elements) {
|
||||||
return process.env.FB_INTERNAL ? [] : elements;
|
return process.env.FB_INTERNAL ? [] : elements;
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
function FBInternalOnly(elements, fallback) {
|
||||||
"features": {
|
return process.env.FB_INTERNAL == 1 ? elements : fallback || [];
|
||||||
"Features": [
|
|
||||||
"features/index",
|
|
||||||
"features/logs-plugin",
|
|
||||||
"features/layout-plugin",
|
|
||||||
"features/navigation-plugin",
|
|
||||||
"features/network-plugin",
|
|
||||||
"features/databases-plugin",
|
|
||||||
"features/images-plugin",
|
|
||||||
"features/sandbox-plugin",
|
|
||||||
"features/shared-preferences-plugin",
|
|
||||||
"features/leak-canary-plugin",
|
|
||||||
"features/crash-reporter-plugin",
|
|
||||||
"features/share-flipper-data",
|
|
||||||
"features/react-native"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"setup": {
|
|
||||||
"Getting Started": [
|
|
||||||
...FBInternalOnly([
|
|
||||||
"getting-started/fb/using-flipper-at-facebook"
|
|
||||||
]),
|
|
||||||
"getting-started/index",
|
|
||||||
"getting-started/android-native",
|
|
||||||
"getting-started/ios-native",
|
|
||||||
"getting-started/react-native",
|
|
||||||
"getting-started/react-native-android",
|
|
||||||
"getting-started/react-native-ios",
|
|
||||||
"troubleshooting"
|
|
||||||
],
|
|
||||||
"Plugin Setup": [
|
|
||||||
"setup/layout-plugin",
|
|
||||||
"setup/navigation-plugin",
|
|
||||||
"setup/network-plugin",
|
|
||||||
"setup/databases-plugin",
|
|
||||||
"setup/images-plugin",
|
|
||||||
"setup/sandbox-plugin",
|
|
||||||
"setup/shared-preferences-plugin",
|
|
||||||
"setup/leak-canary-plugin",
|
|
||||||
"setup/crash-reporter-plugin"
|
|
||||||
],
|
|
||||||
"Advanced": [
|
|
||||||
"custom-ports",
|
|
||||||
"stetho"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"extending": {
|
|
||||||
"Extending Flipper": [
|
|
||||||
"extending/index"
|
|
||||||
],
|
|
||||||
"Tutorial": [
|
|
||||||
"tutorial/intro",
|
|
||||||
"tutorial/ios",
|
|
||||||
"tutorial/android",
|
|
||||||
"tutorial/react-native",
|
|
||||||
"tutorial/js-setup",
|
|
||||||
"tutorial/js-table",
|
|
||||||
"tutorial/js-custom",
|
|
||||||
"tutorial/js-publishing"
|
|
||||||
],
|
|
||||||
"Plugin Development": [
|
|
||||||
"extending/js-setup",
|
|
||||||
"extending/js-plugin-api",
|
|
||||||
"extending/create-table-plugin",
|
|
||||||
"extending/ui-components",
|
|
||||||
"extending/styling-components",
|
|
||||||
"extending/search-and-filter",
|
|
||||||
"extending/create-plugin",
|
|
||||||
"extending/client-plugin-lifecycle",
|
|
||||||
"extending/send-data",
|
|
||||||
"extending/error-handling",
|
|
||||||
"extending/testing",
|
|
||||||
"extending/debugging",
|
|
||||||
...FBInternalOnly([
|
|
||||||
"extending/fb/desktop-plugin-releases"
|
|
||||||
]),
|
|
||||||
...FBInternalOnly([ // TODO: Remove once sandy is public T69061061
|
|
||||||
"extending/fb/sandy/sandy-plugins"
|
|
||||||
])
|
|
||||||
],
|
|
||||||
"Other Platforms": [
|
|
||||||
"extending/new-clients",
|
|
||||||
"extending/establishing-a-connection",
|
|
||||||
"extending/supporting-layout"
|
|
||||||
],
|
|
||||||
"Internals": [
|
|
||||||
"extending/arch",
|
|
||||||
"extending/layout-inspector",
|
|
||||||
"extending/testing-rn"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
features: {
|
||||||
|
Features: [
|
||||||
|
'features/index',
|
||||||
|
'features/logs-plugin',
|
||||||
|
'features/layout-plugin',
|
||||||
|
'features/navigation-plugin',
|
||||||
|
'features/network-plugin',
|
||||||
|
'features/databases-plugin',
|
||||||
|
'features/images-plugin',
|
||||||
|
'features/sandbox-plugin',
|
||||||
|
'features/shared-preferences-plugin',
|
||||||
|
'features/leak-canary-plugin',
|
||||||
|
'features/crash-reporter-plugin',
|
||||||
|
'features/share-flipper-data',
|
||||||
|
'features/react-native',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
setup: {
|
||||||
|
'Getting Started': [
|
||||||
|
...FBInternalOnly(['getting-started/fb/using-flipper-at-facebook']),
|
||||||
|
'getting-started/index',
|
||||||
|
'getting-started/android-native',
|
||||||
|
'getting-started/ios-native',
|
||||||
|
'getting-started/react-native',
|
||||||
|
'getting-started/react-native-android',
|
||||||
|
'getting-started/react-native-ios',
|
||||||
|
'troubleshooting',
|
||||||
|
],
|
||||||
|
'Plugin Setup': [
|
||||||
|
'setup/layout-plugin',
|
||||||
|
'setup/navigation-plugin',
|
||||||
|
'setup/network-plugin',
|
||||||
|
'setup/databases-plugin',
|
||||||
|
'setup/images-plugin',
|
||||||
|
'setup/sandbox-plugin',
|
||||||
|
'setup/shared-preferences-plugin',
|
||||||
|
'setup/leak-canary-plugin',
|
||||||
|
'setup/crash-reporter-plugin',
|
||||||
|
],
|
||||||
|
Advanced: ['custom-ports', 'stetho'],
|
||||||
|
},
|
||||||
|
extending: {
|
||||||
|
'Extending Flipper': ['extending/index'],
|
||||||
|
Tutorial: [
|
||||||
|
'tutorial/intro',
|
||||||
|
'tutorial/ios',
|
||||||
|
'tutorial/android',
|
||||||
|
'tutorial/react-native',
|
||||||
|
'tutorial/js-setup',
|
||||||
|
'tutorial/js-table',
|
||||||
|
'tutorial/js-custom',
|
||||||
|
'tutorial/js-publishing',
|
||||||
|
],
|
||||||
|
'Plugin Development': [
|
||||||
|
'extending/js-setup',
|
||||||
|
'extending/js-plugin-api',
|
||||||
|
'extending/create-table-plugin',
|
||||||
|
'extending/ui-components',
|
||||||
|
'extending/styling-components',
|
||||||
|
'extending/search-and-filter',
|
||||||
|
'extending/create-plugin',
|
||||||
|
'extending/client-plugin-lifecycle',
|
||||||
|
'extending/send-data',
|
||||||
|
'extending/error-handling',
|
||||||
|
'extending/testing',
|
||||||
|
'extending/debugging',
|
||||||
|
...FBInternalOnly(['extending/fb/desktop-plugin-releases']),
|
||||||
|
...FBInternalOnly([
|
||||||
|
// TODO: Remove once sandy is public T69061061
|
||||||
|
'extending/fb/sandy/sandy-plugins',
|
||||||
|
]),
|
||||||
|
],
|
||||||
|
'Other Platforms': [
|
||||||
|
'extending/new-clients',
|
||||||
|
'extending/establishing-a-connection',
|
||||||
|
'extending/supporting-layout',
|
||||||
|
],
|
||||||
|
Internals: [
|
||||||
|
'extending/arch',
|
||||||
|
'extending/layout-inspector',
|
||||||
|
'extending/testing-rn',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
'fb-internal': {
|
||||||
|
'FB Internal': FBInternalOnly([
|
||||||
|
'fb/active-linters',
|
||||||
|
'fb/Add-flipper-to-android-app',
|
||||||
|
'fb/adding-analytics-0',
|
||||||
|
'fb/Adding-flipper-to-ios-app',
|
||||||
|
'fb/adding-npm-dependencies-0',
|
||||||
|
'fb/Add-Support-Group-to-Flipper-Support-Form',
|
||||||
|
'fb/android-plugin-development-Android-interacting-0',
|
||||||
|
'fb/android-plugin-development-testing-android-plugins-0',
|
||||||
|
'fb/building-a-linter',
|
||||||
|
'fb/create-new-plugin',
|
||||||
|
'fb/developmentworkflow',
|
||||||
|
'fb/Flipper-fbsource-Pinning',
|
||||||
|
'fb/Flipper-Release-Cycle',
|
||||||
|
'fb/Flipper-Strict-TypeScript',
|
||||||
|
'fb/Help-Updating-Flipper',
|
||||||
|
'fb/ios-plugin-development-sending-data-to-an-i-o-s-plugin-0',
|
||||||
|
'fb/ios-plugin-development-testing-i-o-s-plugins-0',
|
||||||
|
'fb/LauncherConfig',
|
||||||
|
'fb/layout-extending-android-layout-inspector',
|
||||||
|
'fb/layout-extending-i-o-s-layout-inspector',
|
||||||
|
'fb/Memory-Tools',
|
||||||
|
'fb/mobile-config',
|
||||||
|
'fb/Navigation-Plugin',
|
||||||
|
'fb/plugins',
|
||||||
|
'fb/sections',
|
||||||
|
'fb/supporting-feed-inspector',
|
||||||
|
'fb/Trace',
|
||||||
|
'fb/troubleshooting',
|
||||||
|
'fb/TypeScript',
|
||||||
|
'fb/using-gatekeepers',
|
||||||
|
'fb/index',
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|||||||
Reference in New Issue
Block a user