Commit Graph

187 Commits

Author SHA1 Message Date
Kevin Strider
50919e26f5 public-releases.mdx (Under the Hood - Public Flipper Releases)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: passy

Differential Revision: D36666339

fbshipit-source-id: 4c57746bd62fd52fa8dff4fda3098c443941ae30
2022-05-26 04:24:33 -07:00
Kevin Strider
23f73f0b1e testing-rn.mdx (Under the Hood - Testing RN Changes)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: passy

Differential Revision: D36666807

fbshipit-source-id: 6da969a81a28fc7f9cd7cd8deb3fe341b5516ee2
2022-05-26 03:44:28 -07:00
Kevin Strider
b75eeb941b client-plugin-lifecycle.mdx (Creating Plugins - Client Plugin Lifecycle)
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

This diff includes a new version of the images:
bg-plugin-lifecycle.png
regular-plugin-lifecycle.png

The old versions have been renamed to:
bg-plugin-lifecycle.bak
regular-plugin-lifecycle.bak

Reviewed By: aigoncharov

Differential Revision: D36630758

fbshipit-source-id: 29922750364e1dd6f959bd297e3b5d5e6cf1a9ac
2022-05-25 03:42:25 -07:00
Kevin Strider
ee006a961b architecture.mdx (Creating Plugins - Architecture)
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

This diff includes a new version of the image 'flipper-communication-diagram.png'.
The old version has been renamed to 'flipper-communication-diagram.bak'

Reviewed By: aigoncharov

Differential Revision: D36628993

fbshipit-source-id: cb59785777926b4fb8b8bb3be2aa2439d3a580d0
2022-05-25 03:26:55 -07:00
Kevin Strider
2d465c1bf9 layout-inspector.mdx (Creating Plugins - Extending the Layout Inspector)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: aigoncharov

Differential Revision: D36632888

fbshipit-source-id: 41c4ddceab4ae6a665559093465a73c595aa494f
2022-05-25 03:21:57 -07:00
Kevin Strider
b8292ee62c create-plugin.mdx (Creating Plugins - Client Plugin API)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: aigoncharov

Differential Revision: D36626315

fbshipit-source-id: 735160f8d1f1365a8aab7fb1cd3e99b724025e3a
2022-05-25 03:14:14 -07:00
Kevin Strider
669bc74acd error-handling.mdx (Creating Plugins - Error Handling)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: aigoncharov

Differential Revision: D36626777

fbshipit-source-id: 65c5fcac860ff47c775fc43c053a8a55eb4804e9
2022-05-25 03:11:36 -07:00
Kevin Strider
02058a14d0 flipper-plugin.mdx (CreatingPlugins - Desktop Plugin API)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36594291

fbshipit-source-id: caba082f8bf6ab62c7bd03b3dfeae43f5ec76b7e
2022-05-24 03:29:25 -07:00
Kevin Strider
d9524e893c node-apis.mdx (Creating Plugins - Using Node.js APIs)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: mweststrate

Differential Revision: D36596005

fbshipit-source-id: 9ae71f426fad792af6e13f949581e26f8366baa4
2022-05-23 09:43:57 -07:00
Kevin Strider
cd1345bc28 deeplinks.mdx (Creating Plugins - Using Deeplinks)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: mweststrate

Differential Revision: D36595695

fbshipit-source-id: 7aea6856da2d1e00676c781ffe3d817d6abc58dc
2022-05-23 09:39:07 -07:00
Kevin Strider
1dd2f8bcf1 styling-components.mdx (Creating Plugins - Styling Components)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: mweststrate

Differential Revision: D36595388

fbshipit-source-id: 0d65c3b7099d492c1e3959f9d1d4b3f7c09cd98d
2022-05-23 09:36:58 -07:00
Andrey Goncharov
e40981ee2e Expose isAtom from flipper-plugin
Summary: Required for companion in later diffs

Reviewed By: passy

Differential Revision: D36517737

fbshipit-source-id: ad47ae00cc88f424507284553c7d4eb430691311
2022-05-23 03:38:23 -07:00
Kevin Strider
3dbd3f43e1 sandy-migration.mdx (Creating Plugins - Migrating a Plugin to Sandy)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36516592

fbshipit-source-id: c8f7ffe8ae26a5e741ae818a55b14cc3e35193ff
2022-05-20 03:55:28 -07:00
Kevin Strider
55137371f3 plugin-distribution (Creating Plugins - Plugin Distribution)
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).
* plugin-distribution
* imports: desktop-plugin-releases

Reviewed By: nikoant

Differential Revision: D36514954

fbshipit-source-id: cf350d30c049bc7daeef1af3f988ce3b6a2fb502
2022-05-20 03:53:24 -07:00
Kevin Strider
24864d645e testing.mdx (Creating Plugins - Testing)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36473819

fbshipit-source-id: 567da4bf86bb18298e45c6a139f86eab7c10dd98
2022-05-19 04:27:59 -07:00
Andrey Goncharov
2cff109910 Fix headings for "Desktop Plugin API"
Reviewed By: nikoant

Differential Revision: D36508504

fbshipit-source-id: ece204e5a18d2c98481e21f5c6f0dc42386cf2b5
2022-05-19 02:44:09 -07:00
Kevin Strider
1481eed0c8 debugging.mdx (Creating Plugins - Debugging)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36479883

fbshipit-source-id: 3530dd5f35a36e97a0d7466f981bc8974f29c292
2022-05-18 10:25:25 -07:00
Kevin Strider
3e71216c38 dev-setup.mdx (Creating Plugins - Development Setup)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36445067

fbshipit-source-id: c68dd9973aea50cee35d3db9417e9190dbd5ceda
2022-05-18 10:22:36 -07:00
Andrey Goncharov
88bc3110a5 Add server add-on documentation
Reviewed By: nikoant

Differential Revision: D36446375

fbshipit-source-id: dfa9098428413bff454b5893f022735267dba5b8
2022-05-18 02:20:53 -07:00
Kevin Strider
78d395ad51 loading-custom-plugins.mdx (Creating Plugins - Dynamically Loading Plugins)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36445433

fbshipit-source-id: 6e0033607cf58d5da51dd9910b40f158ceed84cf
2022-05-17 10:03:37 -07:00
Kevin Strider
96e0fffc25 supporting-layout.mdx (SetUp - Implementing Layout Inspection)
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: lblasa

Differential Revision: D36315001

fbshipit-source-id: 6a628abb9328e1c9dbe38c98fd6a12f84563efd4
2022-05-12 03:21:01 -07:00
Kevin Strider
ab8bd29822 establishing-a-connection.mdx (SetUp - Secure Connection)
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: lblasa

Differential Revision: D36313447

fbshipit-source-id: 99f94779caefd7f9f64121a40928c2be2d1f3ff4
2022-05-12 03:19:32 -07:00
Kevin Strider
6cdda85ec9 new-clients.mdx (SetUp - Implementing a Flipper Client)
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D36312999

fbshipit-source-id: 737a1f8a9dc659c7351ac55e0ccc1d4083393aa5
2022-05-11 08:36:41 -07:00
Andrey Goncharov
01a5f3da90 Add generics to server add-on connection
Reviewed By: mweststrate

Differential Revision: D34307356

fbshipit-source-id: 27e61355a85995368ebb197c42d58f4145473567
2022-02-28 03:50:34 -08:00
Andrey Goncharov
bed23c586b Replace style guide references
Summary:
allow-large-files
See D34339758

Reviewed By: jknoxville

Differential Revision: D34378570

fbshipit-source-id: ad451afc1774e6d38902d510629ce1b92457adf0
2022-02-22 08:25:28 -08:00
Andrey Goncharov
342c316c84 Add style guide
Summary:
allow-large-files
See D34339758

Reviewed By: jknoxville

Differential Revision: D34378571

fbshipit-source-id: a7c845f4676b25998dc63bf3029c5d1ec8205611
2022-02-22 08:25:28 -08:00
Lorenzo Blasa
395708348d Remove RSocket documentation references
Summary:
^
Changelog: Remove RSocket documentation references

Reviewed By: jknoxville

Differential Revision: D34345316

fbshipit-source-id: 5b9fac8c04e325f3f02ef3713b0146b17e694c9d
2022-02-21 06:22:44 -08:00
Anton Kastritskiy
f2abbf63db ban interface usage for component props and state
Summary: another eslint rule for flipper codebase

Reviewed By: passy

Differential Revision: D33917213

fbshipit-source-id: e60b867d359ef5b94a481edf0eda318ecff17eee
2022-02-02 05:09:45 -08:00
Anton Kastritskiy
75f874a5dd error for I prefixed interface names
Summary: {gif:kosnw403}

Reviewed By: mweststrate

Differential Revision: D33845782

fbshipit-source-id: 2b9bd70e3b2d930e8f4cd8fe7976ac76f43b2496
2022-01-31 05:34:58 -08:00
Anton Kastritskiy
1aff8466b1 let linter handle type naming conventions
Summary: {gif:kosnw403}

Reviewed By: passy

Differential Revision: D33846715

fbshipit-source-id: 5de4bb0cf88f24f5a26acedb82a0816417fb0787
2022-01-31 02:49:09 -08:00
Anton Kastritskiy
4c83fbb524 warn about ts file extension
Summary: remove statically analysable life from typescript guidelines and let eslint handle it

Reviewed By: passy

Differential Revision: D33819891

fbshipit-source-id: 3cc3cb512607c3651cd3a9e48228d83bab5bb64a
2022-01-28 05:43:46 -08:00
Pascal Hartig
6258169afe Edit dev-setup.mdx using inpage editor
Summary:
Adding this to another place that people seem to overlook.

This diff has been automatically generated by the inpage editor.
                        If you want to update this diff, go through the preview link that would be attached to the test plan.
                        Please ensure you are editing the same page that was used to create this diff.

Reviewed By: antonk52

Differential Revision: D33528019

fbshipit-source-id: ce6bf60b42161fc409277fb8c62ff38fd91b05cf
2022-01-11 07:36:00 -08:00
Michel Weststrate
7efad4201c Document how to use Node.js api's
Summary:
* Documented `npx flipper-server`
* Documented how to properly interact with the OS from Flipper plugins

Reviewed By: antonk52

Differential Revision: D33361929

fbshipit-source-id: 3028de2bf77a9ee6d9e521c1a53cff2388c936ea
2022-01-04 09:06:15 -08:00
Michel Weststrate
87833c759e Fixed an exception when logging unserializable errors
Reviewed By: nikoant

Differential Revision: D33276412

fbshipit-source-id: 615b2cc523a3ab4445a1208f460753b8634f6812
2021-12-22 03:18:51 -08:00
Andrey Goncharov
c96558a524 Remove fs and os usage from Mobile Builds plugin
Summary: Changelog: Expose env info and FS rm command to flipper plugins.

Reviewed By: mweststrate

Differential Revision: D32988478

fbshipit-source-id: 3d0233f9eb34d3478b07e39b9401c0e30ca95135
2021-12-10 06:36:13 -08:00
Andrey Goncharov
5610f8f058 Remove 'path' from plugins
Summary:
1. Add `path` replacement
1. Remove Node's path for all plugins but MobileBuildsPluginContainer (it is probably going to be moved to the server)

Reviewed By: mweststrate

Differential Revision: D32766327

fbshipit-source-id: e636f273842506e752b97cf1b28ce7ac51ce9a12
2021-12-02 04:14:51 -08:00
Anton Nikolaev
ceba421997 Prepend mdx files which used as includes with underscore to avoid creating and indexing pages from them
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
2021-11-30 13:26:17 -08:00
Andrey Goncharov
b82c41eedd Add FileSelector shared component
Summary: Add shared FileSelector component compatibe with the new FlipperLib API

Reviewed By: mweststrate

Differential Revision: D32667100

fbshipit-source-id: dca1e8b7693d134a99617e916c7cfd30432cef78
2021-11-26 08:30:13 -08:00
Anton Kastritskiy
7d4a6437ef Force trailing slash for flipper website
Summary: Use docusaurus new config option to force trailing slashes for all routes and fail build when extensions are not specified in markdown links to prevent flapping urls that lead to 404 in certain situations.

Reviewed By: jknoxville

Differential Revision: D32533292

fbshipit-source-id: a2d5fdff396b3bb4319893634dd637275ea9f598
2021-11-18 09:32:30 -08:00
Andrey Goncharov
ed5c2bd39f Add plugin actions menu
Summary: See D32311662 for details

Reviewed By: mweststrate

Differential Revision: D32329804

fbshipit-source-id: 26670353fdf8580643afcb8bc3493384146f5574
2021-11-12 07:13:56 -08:00
Andrey Goncharov
9b16d0c29a Add documentation
Summary: Document Flipper integration with JavaScript clients.

Reviewed By: passy

Differential Revision: D31827187

fbshipit-source-id: c40d8820241c0f85bd2366a0c087d4270d316c71
2021-10-22 06:30:15 -07:00
Daniel Parreira
6bd4a07286 Fix typo in setup documentation
Summary: Typo on Prettier extension recommendation for internals.

Reviewed By: passy

Differential Revision: D31796887

fbshipit-source-id: c69d0938be198ec6120c2ffb871e109253e00211
2021-10-20 09:17:13 -07:00
Pascal Hartig
1d5a2d876f Add sparse profile
Summary:
If you just use this profile `hg sparse switch tools/scm/sparse/xplat/flipper-js`, your total checkout will only be around 9 gigs.

I officially ran out of patience and out of space with the recent addition of `/arvr` which alone is about 40GB and I mostly touch Flipper files.

I also included staticdocs and the Rust third-party libraries so Launcher, plugin-metrics etc. are supported, too.

Reviewed By: mweststrate

Differential Revision: D31243980

fbshipit-source-id: 650d67d89298901610fa20330b7737f0a304569e
2021-09-29 06:05:22 -07:00
Michel Weststrate
c4538c48d6 Remove deprecated documentation
Summary: Sandy is idiomatic now, cleaned up old docs to avoid confusion as in https://github.com/facebook/flipper/issues/2611.

Reviewed By: passy

Differential Revision: D30908794

fbshipit-source-id: c4076f1d24b193f71923d19eeed631763bb9dacb
2021-09-14 03:12:41 -07:00
Michel Weststrate
9160563ad7 Edit dev-setup.mdx using inpage editor
Summary:
This diff has been automatically generated by the inpage editor.
                        If you want to update this diff, go through the preview link that would be attached to the test plan.
                        Please ensure you are editing the same page that was used to create this diff.

Reviewed By: passy

Differential Revision: D30898394

fbshipit-source-id: ae581edf6a8a84b6ccf2eb75f849bec8bf290f0b
2021-09-13 03:43:50 -07:00
Pascal Hartig
c2aa8bcb59 Edit new-clients.mdx using inpage editor
Summary: Fix broken link.

Reviewed By: mweststrate

Differential Revision: D30805274

fbshipit-source-id: e1c61cde01818b7c087d5e3d7b2f6b247b210358
2021-09-08 05:13:48 -07:00
Wenhuan Li
69924e26e0 Edit sandy-migration.mdx using inpage editor
Summary:
This diff has been automatically generated by the inpage editor.
                        If you want to update this diff, go through the preview link that would be attached to the test plan.
                        Please ensure you are editing the same page that was used to create this diff.

Reviewed By: timur-valiev

Differential Revision: D30767036

fbshipit-source-id: 8e828f9f6fb6a5590be428ed325418a62df55c4d
2021-09-06 09:42:25 -07:00
Wenhuan Li
07e82aae9f Edit sandy-migration.mdx using inpage editor
Summary:
This diff has been automatically generated by the inpage editor.
                        If you want to update this diff, go through the preview link that would be attached to the test plan.
                        Please ensure you are editing the same page that was used to create this diff.

Reviewed By: nikoant

Differential Revision: D30685168

fbshipit-source-id: cf5fa06d23390e293b8986e513d9b739efd5210b
2021-09-01 11:46:27 -07:00
Pascal Hartig
23dd014075 Add keyserver note
Summary: Got a question about this. Writing it down here for future reference.

Reviewed By: jknoxville

Differential Revision: D30452788

fbshipit-source-id: b2d4610b8df6027cd6045d37b941779f1f6096d1
2021-08-23 05:22:56 -07:00
Hafiz Saqib Javed
029b00c4ca Added missing quotation marks (#2709)
Summary:
The documentation had a missing quotation mark.

## Changelog
Fixed missing quotation mark

Pull Request resolved: https://github.com/facebook/flipper/pull/2709

Test Plan: No code affected

Reviewed By: passy

Differential Revision: D30450063

Pulled By: jknoxville

fbshipit-source-id: 8e70d321d5cbf51439c67cca23471e208d0861b2
2021-08-20 08:20:50 -07:00