Summary:
Provide a documentation about marketplace feature of Flipper.
This should cover:
1. Introduction of the feature (plugin discovery, auto update)2.
2. Marketplace server - to list available plugins
3. Flipper settings - describe the new settings and how to enable4.
Closes https://github.com/facebook/flipper/issues/3545.
## Changelog
Pull Request resolved: https://github.com/facebook/flipper/pull/4395
Reviewed By: antonk52
Differential Revision: D42918936
Pulled By: passy
fbshipit-source-id: 50b10178b569ecc6ea65b736ea58db401cf686c6
Summary:
This diff includes minor changes to the pages within the Under the Hood section of Flipper Docs.
The page Creating Plugins -> Desktop Plugin APIs -> QPL Linting -> Building a Linter is now removed from the sidebar.
Reviewed By: lblasa
Differential Revision: D41533283
fbshipit-source-id: 63e50210815fe2b67ea54991eb8a7bc16e04e1be
Summary: This diff includes minor changes to the pages within the Under the Hood section of Flipper Docs.
Reviewed By: passy
Differential Revision: D41521538
fbshipit-source-id: 35b372ffdde118faef2732e4cb7684fc9df18f87
Summary: Wanted to write about this for a while as we're reinventing the rules every time we get to this time of the year. :)
Reviewed By: LukeDefeo, antonk52
Differential Revision: D41434886
fbshipit-source-id: 445c6c259bee74874472cf246fdc209e82514fcd
Summary: Pretty much copy/paste from Pascal's post on data pipelines as it provides a quick overview of things involved
Reviewed By: passy
Differential Revision: D41274753
fbshipit-source-id: 337b034d2460ba448582b9dea70b835898627faa
Summary: This change alphabetically sorts the 'Under the Hood' section and adds a 'Meta' parent category for everything that is internal as to add a visual cue of what is internal and whats not.
Reviewed By: passy
Differential Revision: D41273678
fbshipit-source-id: 1acf8da184762d5924bff90b6691be1e4be92c46
Summary: Wanted to write down the not-obvious release procedure somewhere. We can extend this with some troubleshooting procedures.
Differential Revision: D37463848
fbshipit-source-id: 899cdfd12fdb0647579271d883f499872167743f
Summary:
This is a new section under 'Contributing to the Documentation', in the 'Under the Hood' menu.
It includes two new pages:
* Documentation Formatting Tips (created here. For content, see D37006489)
* Writing Guide (created here. For content, see D37006980)
Setup in sidebar.js.
Reviewed By: lblasa
Differential Revision: D37004092
fbshipit-source-id: 5fa0a38632f7fa9d9178b69a89d9b21f5bda39ab
Summary:
Kevin Strider after reviewing Flipper docs structure suggested to show all sections in sidebar. This will make it easier for users to navigate website as they will be able to find all the content through sidebar menu.
Before that only current section items were shown, so e.g. if user clicks "Learn more" on the start page they open "Features" section and it's not clear that there are a lot of other content (Setup, Creating Plugins, Under the Hood) which is only available through the top menu.
Reviewed By: antonk52
Differential Revision: D36762008
fbshipit-source-id: a36cfb77e5d2efd4f5d8795d1c68e46d07ed79e1
Summary:
LukeDefeo called out that there's currently no guide for how to create changelog items.
I couldn't find another good page to add this to. Might be a good idea to expand this with further tips for making good contributions.
Reviewed By: LukeDefeo, nikoant
Differential Revision: D36702634
fbshipit-source-id: 15bc1dcf420ea923a714929eff8ac817efa56ceb
Summary: Troubleshooting docs structure refactored. This should fix publishing of docs on GitHub which is currently failing, because of link to fb-only page from public page: https://github.com/facebook/flipper/actions/runs/2351680003.
Reviewed By: passy
Differential Revision: D36513180
fbshipit-source-id: c0339d437f560464e771e46dfc0a55782faf6a54
Summary:
Major changes to js-custom.mdx
The content for the following pages is moved to the new sub-folder 'Building a Desktop Plugin':
* js-custom.mdx
* js-setup.mdx
* js-table.mdx
The Title and Sidebar labels have been changed accordingly.
Changes made to sidebar.js,
Reviewed By: lblasa
Differential Revision: D36415874
fbshipit-source-id: 8f1634abc1459d1905da62a1b76bac4b621d0da5
Summary: Restyle of Trobleshooting, which involved changes to sidebar.js and splitting up the previous troubleshooting page into five separate pages.
Reviewed By: lblasa
Differential Revision: D36282539
fbshipit-source-id: e60834e2b4d98b70b23bb11309c3438d85e4de0e
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
