Summary: We get a lot of requests related to things not working on RN. The questions and solutions are often quite similar, so wrote down all the answers I know from the top of my head. From now on we can link to this guide, and extend it were needed with better answers
Reviewed By: passy
Differential Revision: D22042296
fbshipit-source-id: ba8a71f3ef6f241aaa1d2883d1348c0471a38e3b
Summary:
We have a bunch of code blocks using languages that aren't rendered by default, so adding syntax highlighting for those languages.
Also, some uses are using the wrong "name" for the language, so I've fixed them.
Reviewed By: mweststrate
Differential Revision: D21974341
fbshipit-source-id: 17146ea5ae4979241c51b3707035470e9742a104
Summary:
Relative links like these appear to have broken with Docusaurus 2.
Supersedes, closes https://github.com/facebook/flipper/pull/1200.
Reviewed By: jknoxville
Differential Revision: D21935451
fbshipit-source-id: 72a50730fba02b395a1bcd924745bfbaf066cb93
Summary: cekkaewnumchai asked about this and I didn't just want to type this out in a chat.
Reviewed By: cekkaewnumchai
Differential Revision: D21766920
fbshipit-source-id: e476d9d39461032d82bdd1bdf2b284d47a55af21
Summary:
Based on the issue here https://github.com/facebook/flipper/issues/967, I'm adding the flipper diagram to a documentation.
It should help explain briefly how does all parts communicate together and visualise key terms.
## Changelog
- Add Flipper architecture diagram to documentation
Pull Request resolved: https://github.com/facebook/flipper/pull/1073
Reviewed By: jknoxville
Differential Revision: D21278322
Pulled By: passy
fbshipit-source-id: 3cd8c71b2595b86911f5c9061bc2e8119da1d315
Summary:
Currently user’s are being told to add a definition of the `FB_SONARKIT_ENABLED` macro and examples, including those in stock React Native templates, set this for the user by making use of a `post_install` hook in the user’s `Podfile`. This leads to confusion, fragile code [when a user’s project dir structure deviates from vanilla], and is ultimately not necessary as CocoaPods already has dedicated mechanisms to:
* specify build settings (through the `xcconfig` property);
* and selectively include certain pods only in certain build configurations (e.g. debug).
Finally, this PR also includes a commit [to fix the current builds](https://github.com/facebook/flipper/pull/1086/files#r418526812).
## Changelog
> Entirely control Flipper being enabled through inclusion in Podfile and optionally limiting to certain build configurations using the `:configuration` directive.
Pull Request resolved: https://github.com/facebook/flipper/pull/1086
Test Plan: I have built and ran the Sample application, as well as used this version of Flipper with a new RN app built from `master`.
Reviewed By: passy
Differential Revision: D21381828
Pulled By: priteshrnandgaonkar
fbshipit-source-id: edf6dae28eb02336a49e8230654d6186360ea8d6
Summary:
Somehow I missed these two the last time.
These are the final broken links reported by https://www.brokenlinkcheck.com/broken-links.php#status except for the "edit this page" link on the autogenerated ui-components page.
Reviewed By: mweststrate
Differential Revision: D21325511
fbshipit-source-id: dbc61bbed1366a007ed2cdde3a72f8ea974d871f
Summary:
Used https://www.brokenlinkcheck.com/broken-links.php#status for now to find broken links and fixed them all.
Would be better to use some automated tool to check this at diff time, but that's not setup yet.
Reviewed By: passy
Differential Revision: D21301702
fbshipit-source-id: f13c8769b15d9f99563fc65dc0544320d07a2bfb
Summary:
KESHAmambo pointed out some internal links are broken on the website: https://twitter.com/KESHAmambo/status/1255443093542895619
The way relative links are processed in docusaurus v1 and v2 has changed. This fixes them up.
Reviewed By: mweststrate
Differential Revision: D21301293
fbshipit-source-id: 7610e38a55bc066625373cf2eee9a3efb63aec08
Summary:
Numbered list syntax changed during the docusaurus migration from v1 to v2.
It looks wrong at https://fbflipper.com/docs/extending/js-setup/
This fixes it.
I searched for "1)" and replaced all numbered lists it found.
Reviewed By: mweststrate
Differential Revision: D21283693
fbshipit-source-id: adeb6e04693f50e0a0cfe4b2de5f4663075c34ce
Summary: "migrate" command for easy migration of existing Flipper plugins to the specification version 2.
Reviewed By: passy
Differential Revision: D21253913
fbshipit-source-id: 9edb170fbaa10e9c3f670d5d68e69f4f6106c151
Summary:
Implemented json schema for flipper plugin package.json and used it for validation in "flipper-pkg lint" command.
Nice thing about json schema is that it not only allows to validate json, but also can be referenced using "$schema" property in json so IDEs like VSCode can find it and use for code completion, validation and to show properties documentation. I'm going to deploy the schema as a part of documentation website so it can be referenced as https://fbflipper.com/schemas/plugin-package/v2.json.
Also the "$schema" field can be used instead of "specVersion" to determine the specification according to which the plugin is defined. E.g., if specification version 3 would be created, it will be described in schema https://fbflipper.com/schemas/plugin-package/v3.json, etc.
Reviewed By: passy
Differential Revision: D21228294
fbshipit-source-id: f21351e584ef936a7d6b314436448489691f83a6
Summary:
Background for this diff: https://fb.quip.com/KqEfAlKYlgme
Some plugins don't respect that stuff (livefeed and graphql), but for others it seems to work fine.
This is just a PoC, there are some present bugs concerning the combination of selecting and bg plugins
Questions to investigate:
- [x] make sure that LiveFeed and GraphQL disconnect properly. There might be more plugins that need that
- [x] verifiy that we don't loose one of the original goals of background plugins, e.g. QPL collecting and sending data from device start. Does this still work as intended after this change?
- [x] how can we observe / measure improvements? Are dev builds more responsive after this? Is the layout inspector smoother for example because no QPL plugins are interweaved?
- [x] how is forward and backward compatibility?
- If Flipper is updated, but device not: No change I think, as getBackgroundPlugins() will return an empty set, and background plugins are initiated as usual, so old behavior
- If device is updated, but Flipper not, background plugins won't be started until they are selected. This is a degradation, but hopefully explainable.
- [x] Verify QPL buffer is not unbounded
- [x] Share architecutre changes with team
For Graphql updates: D20943455
Added runtime stats to monitor network traffic (sadly had to redo that since scuba couldn't handle the data format used at first, so probably will hold of landing this diff a week to make sure we can see some effects)
Follow up work:
[x] wait until we released the stat tracking before we release this, to be able to measure the effect?
[x] make sure graphql fix lands
[ ] use side effects abstraction
[ ] fix other background plugins (android only) or fix it in a generic way:
{F234394286}
Changelog: Background plugins will no longer receive a Flipper connection if they are disabled. This should significantly reduce the overall load of Flipper both on the device and desktop when unused plugins are disabled used, which could otherwise generate 10MB/s of network traffic certain scenarios. All plugins *should* be able to handle to this gracefully, but since this is quite a fundamental change, reach out to the Flipper team when in doubt!
Reviewed By: jknoxville
Differential Revision: D20942453
fbshipit-source-id: b699199cb95c1b3e4c36e026b6dfaee7d1652e1f
Summary:
Docusaurus 2 is quite a lot more powerful than docu 1 it turns out.
This should convert the website fully.
* [done] Go through migration guide https://v2.docusaurus.io/docs/migrating-from-v1-to-v2
* [done] Convert landing page html
* [done] Convert all images to img tags
* [done] Convert all .md files to .mdx
* [done] Make sure ui-doc generation and including still works
* [done] Scan every page visually for sanity check
* [done] Make sure footer still works
* [done] Make sure search still works
* [done] Change all links/ to links/index
* [done] Change all links.md to links
* [done] Add some custom css to make the navbar look like the old one and darken the footer.
Reviewed By: passy
Differential Revision: D21158717
fbshipit-source-id: 5f45b711b1b6fd5ece4c5c15c55635c7ebbfb568
Summary: Flipper should never be a normal dependency of a flipper plugin. And since this an example, lets do it properly :)
Reviewed By: jknoxville, passy
Differential Revision: D21228427
fbshipit-source-id: 72166c8706a213e2cb649f1201984dd722b63d2f
Summary:
Assets should never be referenced by /doc/assets, as it breaks docusaurus' baseUrl conversion.
I'd write a lint rule for this but I don't know if it affects docusaurus v2, might be better to just migrate to that.
Reviewed By: passy
Differential Revision: D21153686
fbshipit-source-id: d839015e989a64f897617855ece77439da388cb7
Summary:
Pull Request resolved: https://github.com/facebook/flipper/pull/1016
YogaKit's version is compatible recent version of swift and also before the last release its swift version was not mentioned, which caused issues, but now there is no need to set the swift version.
Reviewed By: passy
Differential Revision: D21054723
fbshipit-source-id: 2210cf4beab86088533302028091e0bc44b9d232
Summary:
This PR fixes a broken `Troubleshooting` link in the iOS setup page as well as adds that link to the React Native iOS one.
## Changelog
Add correct `Troubleshooting` page links
Pull Request resolved: https://github.com/facebook/flipper/pull/1013
Test Plan: Check `docs/getting-started/native-ios` and `docs/getting-started/react-native-ios`.
Reviewed By: mweststrate
Differential Revision: D21042264
Pulled By: passy
fbshipit-source-id: 3b069b3ffa51d5d290af410d8c85ecb316d76c32
Summary:
We've ported [Reactotron](https://infinite.red/reactotron) to work as a Flipper plugin. This adds a new section listing known community plugins and starts with Reactotron-in-Flipper as an example.
## Changelog
Added one section to the React Native page.
Pull Request resolved: https://github.com/facebook/flipper/pull/1009
Test Plan: Docs-only.
Reviewed By: passy
Differential Revision: D21039079
Pulled By: mweststrate
fbshipit-source-id: 1187119d78baba321012f8ffa243685b25441e9d
