Summary: Document how device identifiers are obtained and used to map apps and their running device.
Reviewed By: passy, aigoncharov
Differential Revision: D33431864
fbshipit-source-id: eff4475b3b5e796b58c04db872e814f3e7d5d79e
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
Summary: Starting just with Android On Demand. iOS will follow shortly.
Reviewed By: antonk52
Differential Revision: D32724229
fbshipit-source-id: b4276aae2a7349815d691b854adcfc531b702ae7
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
Summary:
Prep for the Sustainathon. I wrote down how to deal with the lint warnings we want to
enforce.
Reviewed By: mweststrate
Differential Revision: D30450421
fbshipit-source-id: e0647c1cea873c0b8a51e98d19d7aaf253f29dca
Summary:
Added docs on how to use deeplink.
Note that not all features are implemented yet.
Reviewed By: fabiomassimo
Differential Revision: D29845044
fbshipit-source-id: 835fba8ce97c2106d160f347675e11d1ed749fba
Summary: Just some documentation on documenting plugins
Reviewed By: jknoxville
Differential Revision: D29488048
fbshipit-source-id: 1fef3d66894e7e2659043c02c82dab71963ecbff
Summary: Moved plugin documentation and related assets to plugin folders, fixed links and configured redirects where required. Now these docs are used for both showing docs in Flipper and generating Flipper docs website.
Reviewed By: passy
Differential Revision: D29465567
fbshipit-source-id: 3ec4240b215b0d5baea5154f64266a9ba7ead3a5
Summary:
This diff changes the way on how plugin documentation is produced. Instead of keeping plugin documentation together with other docs, we will now keep it together with plugin code. There are multiple advantages of such solution:
1. We are generating docs for every plugin in a standartised way so all of them looks similar. We can also use plugin metadata for generation as well (e.g. take title, icon, oncall name etc from package.json).
2. Standartised plugin docs make it possible to build docs both for websites (public and internal) and for embedding into Flipper.
3. It will hopefully incentivise authors to write docs as they will be a part of plugin "package".
4. We can scaffold documentation template using scarf to further incentivise filling it.
Reviewed By: jknoxville
Differential Revision: D29378053
fbshipit-source-id: 66ea48dc9ba225fabfb256ae6a10f8c81eef6f5f
Summary: Another thing I spent way too long searching for. Let's just write it down in our docs.
Reviewed By: fabiomassimo
Differential Revision: D29430439
fbshipit-source-id: 0fede7f34308f47376631a58054c144d59596419
Summary: Had to look this up too many times so decided to write it all down.
Reviewed By: mweststrate
Differential Revision: D29427599
fbshipit-source-id: b269768722b36959cfae75ecbdd6c9a7519fe73e
Summary: Since the functionality is now available as part of DataTable, the HoC doesn't seem to be needed as generic abstraction. it is used in handful places outside datatable / datalist, but those can be localized in the future or should datatable / datalist.
Reviewed By: fabiomassimo
Differential Revision: D28993836
fbshipit-source-id: 3e6da7c7b48348faa0c4f7281868196f5585a065
Summary:
The current desktop plugin tutorial was outdated as it has several steps that are now automated, and still referred to old APIs. This has been updated now.
Additionally left the intermediate code of the tutorial in the plugin, but splitting `index.tsx` into `index_table.tsx` and `index_custom.tsx` (which will be updated in the next diff)
Clarified the tutorial page labels a little bit to show that 3 pages are covering the Desktop plugin development process.
Changelog: Updated the Desktop plugin tutorial
Reviewed By: jknoxville
Differential Revision: D28990029
fbshipit-source-id: a06a7a774ceca3daf10f8e8fbd4e03191dbfd1cc
Summary:
Noticed this when building the site. Shame it only warns and doesn't fail the build.
Just fixing it while I'm here.
{F479009268}
Reviewed By: nikoant
Differential Revision: D26911725
fbshipit-source-id: 6440a4b8aee4a6bc053ae771a3b148fd70ffc298
Summary: This diff adds documentation for using physical devices to connect to Flipper. It also talks about simulators and emulators
Reviewed By: jknoxville
Differential Revision: D26780077
fbshipit-source-id: 47a08cec55c510abd36c2fc776f4ce05ff0ea4d0
Summary:
Give the sdk installation pages a bit more structure.
To me it's much clearer now what they are.
Happy to hear differing opinions so we get it right :)
Reviewed By: passy
Differential Revision: D25638164
fbshipit-source-id: 86b7fecd8aba0068336b15a308f4a9433817c68e
Summary:
The installation instructions didn't flow very well.
"Using flipper at Facebook" is now gone. It's installation steps have been moved into the desktop app page, with internal/external switching.
I've also removed the "Updating Flipper" internal page, and put equivalent info in the installation section.
Reviewed By: nikoant
Differential Revision: D25637831
fbshipit-source-id: 2af2abf57793d54804f5c45e3335b8641743e1c8
Summary:
I think there's a need for an "implementation details" section of the site. Especially as we're moving the rest of our wiki content there.
I see it as a good thing, because now we have a place for implementation details relevant to OSS contributors too, it's not all fb-specific.
Reviewed By: nikoant
Differential Revision: D25614909
fbshipit-source-id: 5ec081e6450a9ad1c30785ae4cca74b6fa0d2630
Summary:
Ran the wiki migration script on the Flipper_Internals wiki.
Deleted the pages mentioned in https://www.internalfb.com/tasks/?t=81712504
Also deleted hacking-launcher, which is now succeeded by the new "hacking-on-launcher".
Reviewed By: nikoant
Differential Revision: D25613387
fbshipit-source-id: b57b3e20f37b556774d7748477a1dbb7fe844812
Summary: This diff unifies setup and workflow information that was scattered a bit around into one cohesive 'Development workflow' subsection in the 'creating plugins' section of Flipper.
Reviewed By: nikoant
Differential Revision: D25612288
fbshipit-source-id: 5fa7f2d000fb7ab3e1b5c5a4fc8cc1f209252f41
Summary: There were 3 pages describing how to obtain a plugin instance, public, ios and android. iOS didn't differ from the public one, and android only in the fact that internally DI is available. So combined the pages with just an optional section for DI inside FB on Android.
Reviewed By: jknoxville
Differential Revision: D25588057
fbshipit-source-id: 3a54ae699130a4c5ba018220708f844a35a8d6a9
Summary: There was one public page for testing client plugins, and two internal ones. Combined it into a one pager, that has tabs per target, with separate content for internal versus external (didn't combine those as the testing frameworks recommended differ)
Reviewed By: nikoant
Differential Revision: D25588058
fbshipit-source-id: afa151ec0c3a5de26142938d3d389627716f1ff7
Summary: send data was documented twice, in the general client API, and in the internal docs where it was specifically combined with obtaining a plugin instance. However, that is a proper public API as well, so combined those two.
Reviewed By: nikoant
Differential Revision: D25588059
fbshipit-source-id: 7135a74b64a87d0c8c3f8f20f7f260469f52d41c
Summary:
Moving this file outside of the "FB Internal section" so we can get rid of it.
I think this file can probably be replaced by the "flipper marketplace" at some point, driven programatically by package.json files etc, but I'm not sure if such a page exists at the moment.
Reviewed By: passy
Differential Revision: D25588707
fbshipit-source-id: 0809c21b30410252ef146cfcd161b836849dbbf0
Summary:
The old Wiki (https://www.internalfb.com/intern/wiki/Flipper_Internals/hacking-launcher/)
is still mostly accurate but contains a lot of information about the deprecated Dewey pipeline.
Reviewed By: mweststrate
Differential Revision: D25586307
fbshipit-source-id: 82345510e19986f763bc0547d25330a0369309fb
Summary:
This diff restructures the 'extending' section of the docs, and rebrands it to 'creating plugins'. It then restructures this section into 4 top-level items
* Tutorial
* Desktop plugin APIs
* Client plugin APIs
* Workflow
Pages are put under the relevant sections, including pages which were before under internal. Some pages that didn't relate directly to plugin development have been moved to other top level sections (e.g. testing RN).
I didn't do de-duplication between pages yet, that will be done in the next diff.
Overview of changes:
* Extending -> Creating Plugins
* Moved Extending > Other platforms to Setup > Other platforms (as this is about clients, not plugins)
* Moved Internal FB plugin development stuff into Creating Plugins
* Separated Creating Plugins into ‘Tutorial’, Desktop API Reference, Cient API Reference, Workflow
* Remove TypeScript strict page, we are already strict
* Moved QPL linters to api docs and named id QPL lints
* Grouped the different pages on extending Layout plugin (needs deduping still)
* Warning about avoiding custom styling in general
* Moved internal index page to the top of the navigation of FB Internal, rather than at the bottom
Reviewed By: passy
Differential Revision: D25585172
fbshipit-source-id: ba2aa891395097d6aa101809084b915f115ee69d
Summary:
Now in public, the setup page remains unchanged, well, the headings are one level smaller.
In internal, the page is divided into two sections: for buck based apps, and non-buck based ones.
Reviewed By: mweststrate
Differential Revision: D25565953
fbshipit-source-id: abf4316a28970cd93d0cc9b56dd707f00a674a48
Summary:
^
The navigation plugin also includes setup instructions which will be moved to it's own page next.
There are also now 2 navigation plugin feature pages. These still need to be consolidated.
Reviewed By: passy
Differential Revision: D25564150
fbshipit-source-id: 1fe0d853f6fa94ec62b39edacd268519fa18485a
Summary:
Putting both iOS setup guides next to each other.
I'm not sure what to call the oss one. It applies to cocoapods, swift, and pure objc.
Reviewed By: passy
Differential Revision: D25563988
fbshipit-source-id: a7ee2a0ae04e5753a74939b1c170d9a2f2ace1a9
Summary: Puts both the "Adding flipper to android apps" page next to each other, one for buck and one for gradle. The buck one is only internal.
Reviewed By: passy
Differential Revision: D25563688
fbshipit-source-id: 1937cfdd0d5129b54a8635efe6294ba39a26be8e
Summary: The 'extending flipper' introduction page didn't contain anything meaty, so collapsed it into the tutorial introduction, cleaning up the top level navigation.
Reviewed By: passy
Differential Revision: D25531718
fbshipit-source-id: ca0f98186e889e13cb97be8818db3588738e5039
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
Summary: This updates the docs of Flipper to use Sandy, rather than `FlipperPlugin` class. Restructured the docs a bit as a result.
Reviewed By: passy
Differential Revision: D24991285
fbshipit-source-id: 66d5760c25cf9cf3983515433dfd64348d51db3d
Summary: Moved docs outside of FBInternal docs. Will make Sandy APIs the default in the docs soon, and move the links to the proper location, but this at least makes sure we can already link to the correct place in WP announcements
Reviewed By: jknoxville
Differential Revision: D24829287
fbshipit-source-id: 913f2db65a7cdd04bd1be47aebc48ece7a6cef04
Summary: It's a lot more than just "launcher" now.
Reviewed By: nikoant
Differential Revision: D24425780
fbshipit-source-id: 74f6dd4d73a224a43608c4d3f3698dbd16c2e865
Summary: Unfortunately optional require does not work with docusaurus bundler configuration in case file not exist, so open source build is failing now. I'm backing out this commit until solution for dynamic imports in docusaurus found.
Reviewed By: mweststrate
Differential Revision: D23679198
fbshipit-source-id: 9be008f19b5945d17ec31614a8d2cb80bad9ca2e
Summary: Unfortunately optional require does not work with docusaurus bundler configuration in case file not exist, so open source build is failing now. I'm backing out this commit until solution for dynamic imports in docusaurus found.
Reviewed By: mweststrate
Differential Revision: D23679147
fbshipit-source-id: 7934e0a7decf128c1914f52645adaf4617c97eea
