Commit Graph

177 Commits

Author SHA1 Message Date
John Knox
0149296fc1 Reorder extending sidebar
Summary:
JS pages first, then client pages.
Would be nice if we had some sort of separator, but I think you can only have two levels.

Reviewed By: danielbuechele

Differential Revision: D15198312

fbshipit-source-id: 6c9f8d8775f513a55c256366448faed13b671767
2019-05-03 07:10:58 -07:00
John Knox
2588338c41 Tidy up and rename "Mobile Setup" page
Summary:
* Renamed to "Client Plugin API" to align with the "JavaScript Plugin API" page.
* Added some more info and reworded some parts.

Reviewed By: danielbuechele

Differential Revision: D15198192

fbshipit-source-id: 2c86b6a852e9ed52b0885eb5b7db8436028489d5
2019-05-03 07:10:58 -07:00
John Knox
d5573644ac Delete communicating and move the missing info into js-plugin-api
Summary: Documents init in the API reference and deletes the now redundant communicating page.

Reviewed By: danielbuechele

Differential Revision: D15198128

fbshipit-source-id: a9b88632b74edd7d9656ed888192db1fbe7f3642
2019-05-03 07:10:57 -07:00
John Knox
f72e4b5122 Tidy up "Sending data to Plugins" page
Summary:
* Made the code snippets uniform across languages.
* Renamed to "Providing data to plugins" because sending hints at sending across the desktop-client connection which is misleading.

Reviewed By: danielbuechele

Differential Revision: D15198081

fbshipit-source-id: e2c318cdc6055c191f47e846b518c26dd21e4a68
2019-05-03 07:10:57 -07:00
John Knox
57af6fa2bf Add JS Plugin API reference page
Summary: This documents all pretty much the entire API.

Reviewed By: passy

Differential Revision: D15187834

fbshipit-source-id: 073c6a0dc40e3373967e9e5c5b7d44ab9c0aa07f
2019-05-03 04:30:09 -07:00
John Knox
49be7fd35f Redefine Js-Setup as JS Plugin Definition
Summary:
The purpose of this page wasn't that clear to me, though the content is pretty focused. I've changed it from JS setup to JS Plugin Definition, and reworded it a bit.
I think it makes sense if this specifies everything to do with plugins on the file system, and the next page talks about what you do in javascript.

Reviewed By: passy

Differential Revision: D15184829

fbshipit-source-id: 6335ebc8d4297ffcbf1ab9860b4f055fe5bbcf87
2019-05-03 04:30:09 -07:00
John Knox
a276af9c1f Show communcating with devices page
Summary:
This page got lost in the reorganisation. Adding it back.
There's still work to be done on the content and organisation of these docs.

Reviewed By: passy

Differential Revision: D15184349

fbshipit-source-id: 76256ba53189579bec363903dc4068a421cafc98
2019-05-02 12:38:31 -07:00
Pritesh Nandgaonkar
d022cd0e42 Add iOS docs draft for Layout Inspector
Summary:
Updated syntax and code references, but someone else please
check the details here.

Reviewed By: jknoxville

Differential Revision: D15181483

fbshipit-source-id: 93ed636c2d72f33151759e822d77e80e3abd6f03
2019-05-02 12:38:31 -07:00
Pritesh Nandgaonkar
29391db65d Fixed the copy button being overlapped with the text
Summary:
BUG:

{F157319747}

Reviewed By: passy

Differential Revision: D15181532

fbshipit-source-id: cb0f91e7b90b479200cb57c496ae34c87ad35001
2019-05-02 11:31:12 -07:00
John Knox
c3efb7b45e Fix broken link
Summary: n/a

Reviewed By: danielbuechele

Differential Revision: D15182855

fbshipit-source-id: 251d25a5542d66cb238b74cfe9b99936597d85e5
2019-05-02 08:54:49 -07:00
Pascal Hartig
df46c0c63e Add extending Layout Inspector docs
Summary:
Please give feedback on the sidebar placement.

This is only the Android part. I'll put up a second diff copying the iOS thing over
but hope someone can commandeer that and check for accuracy.

Reviewed By: priteshrnandgaonkar

Differential Revision: D15181454

fbshipit-source-id: d32081feefbfb0ffc38890e835a7d5f6b78667ab
2019-05-02 08:44:44 -07:00
Pritesh Nandgaonkar
367bb9a502 Updated the documentation of the crash reporter plugin
Summary: As per title

Reviewed By: passy

Differential Revision: D15181759

fbshipit-source-id: b184c730bbd349cd432956790e8dc192d3fd5ca0
2019-05-02 07:40:58 -07:00
Pritesh Nandgaonkar
384568a4a0 Updated the documentation of the shared preferences plugin
Summary: As per the title

Reviewed By: passy

Differential Revision: D15181533

fbshipit-source-id: ca2b13dc81cd28fd2d6ab84fbdc000006d2d43e9
2019-05-02 04:58:39 -07:00
John Knox
1d7b526add Don't recommend untemplated use of FlipperClient::getPlugin
Summary: We have a templated function not requiring a downcast, so there's no need to use the non-templated one.

Reviewed By: passy

Differential Revision: D15167856

fbshipit-source-id: 2f125ac9ca62d7ac4c633127104d1cd2954a13fb
2019-05-02 04:10:46 -07:00
Daniel Büchele
b0d2983bd4 docs: add code tabs
Summary: adding code tabs for Android, iOS and C++ to improve readability of pages.

Reviewed By: jknoxville

Differential Revision: D15167691

fbshipit-source-id: e7f602a3a1cbe39ef5da0a15bb0bbfc8f79e8ccc
2019-05-01 11:21:54 -07:00
Daniel Büchele
8734b99f8d fixing links, adding nice buttons
Summary: as per title

Reviewed By: jknoxville

Differential Revision: D15167533

fbshipit-source-id: 67d059c478bf0608b598ba7cd6be19157ff41900
2019-05-01 11:21:54 -07:00
John Knox
be7aefc044 Add missing full stop (#429)
Summary:
Trivial change. I missed this earlier.
Pull Request resolved: https://github.com/facebook/flipper/pull/429

Reviewed By: passy

Differential Revision: D15166391

Pulled By: jknoxville

fbshipit-source-id: 3d52eb1da6d21afa9217cc17cfe887a686cde280
2019-05-01 10:27:27 -07:00
Pritesh Nandgaonkar
20379cf7d1 Update network plugin docs for iOS
Summary: Updated the installation instruction for the network plugin

Reviewed By: jknoxville

Differential Revision: D15166206

fbshipit-source-id: c30d18cd7ac62c813e368de914b279f466a1f1c1
2019-05-01 09:45:10 -07:00
John Knox
da44a02cad Add Implementing Layout Inspection docs
Summary: Describes the interface that clients should conform to to implement the layout plugin.

Reviewed By: danielbuechele

Differential Revision: D15166234

fbshipit-source-id: b86303f18f33762f09cfc503ece856cfcc887493
2019-05-01 09:15:51 -07:00
Pascal Hartig
00a7cd9f60 Document no-op package
Summary:
Package is still in the process of getting approved by JCenter
but should get included within the next 24h or so.

Reviewed By: jknoxville

Differential Revision: D15149587

fbshipit-source-id: ab835b1fff23aedbc312b495b79e85e0fffa16ed
2019-05-01 08:38:22 -07:00
John Knox
821408056f Add Searching and Filtering page
Summary: I can't take credit for this, I found it in the internal wiki. Have just modernised it and made it public.

Reviewed By: danielbuechele

Differential Revision: D15165547

fbshipit-source-id: d59344aa6ad47be6ab32b88abcdfc14a7d20c775
2019-05-01 08:31:38 -07:00
Pritesh Nandgaonkar
5b26ce954f Upated the installation instruction for iOS
Summary: Updated the installation instruction for iOS. Also updated the sample app's podfile

Reviewed By: passy

Differential Revision: D15165222

fbshipit-source-id: 33fe27f687619b716b73cea5c3a3a898ea6edc79
2019-05-01 07:32:03 -07:00
Pritesh Nandgaonkar
c12b8d28fb Updated the installation instruction for layout plugin
Summary: Updated the iOS side of installation for layout plugin

Reviewed By: passy

Differential Revision: D15152489

fbshipit-source-id: 3e30b056e82e708a2f4c12c8f6b1d10c80c5b1a0
2019-05-01 06:56:50 -07:00
John Knox
56b85dd6e3 Write up FlipperClient API.
Summary:
Specifies the API for implementing your own Flipper Client.
I believe this provides everything you need to know to build a flipper-compliant client.
The only snag is that the current certificate exchange procedure would require a change to allow for new OS's, device types etc. It would be much better if we had a TLS-opt out so you don't need to go through all that rigmarole.

Reviewed By: passy

Differential Revision: D15150550

fbshipit-source-id: 2878dcc174807c3f86c0562660e8a3e43e5777b1
2019-05-01 04:10:37 -07:00
Daniel Büchele
563d23a514 docs: update screenshots
Summary:
Updating screenshots
adding screenshot slideshow to landing page

Reviewed By: passy

Differential Revision: D15164431

fbshipit-source-id: a7201f59205593e38b48bce87cacdb58e9b2b180
2019-05-01 03:22:35 -07:00
John Knox
b3ec8b052b Add Setup and Extending top level navs
Summary: Distinguish between integrating flipper, and developing plugins.

Reviewed By: passy

Differential Revision: D15148448

fbshipit-source-id: 7c772fa1cea7d5ed789a984039afc37bc0b8a927
2019-04-30 11:06:45 -07:00
John Knox
4c282cea1f Add architecture page and Internals section
Summary: Breifly documents the client-desktop relationship

Reviewed By: passy

Differential Revision: D15147712

fbshipit-source-id: 8292c580538c1cda03450a460a0e08f4a4b8cec2
2019-04-30 11:06:44 -07:00
Daniel Büchele
79622ac19d docs: cross linking from features to setup
Summary: linking from feature page to setup instructions.

Reviewed By: jknoxville

Differential Revision: D15148032

fbshipit-source-id: 66dd2ca07a04d3ac1fb53ad95e91e6d8beb69706
2019-04-30 09:10:12 -07:00
Daniel Büchele
3b03a3d605 docs: add features page
Summary: Adding a "features" page to the to bar and splitting plugin descriptions from their setup instructions.

Reviewed By: jknoxville

Differential Revision: D15147464

fbshipit-source-id: b2106d825454c3b2989eb1e536b128ef9b6d0247
2019-04-30 07:39:16 -07:00
John Knox
6a9ad97622 Document flipper://import handler
Summary: Condensed the open file explanation and added a note about download links.

Reviewed By: passy

Differential Revision: D15124555

fbshipit-source-id: 14f7cfea828bff4cea2e92be10bfa5cdea95723b
2019-04-30 04:16:39 -07:00
Pascal Hartig
a9993ffa52 Update getting-started
Summary:
- Fix some typos.
- Move Objective-C/Swift code blocks under one heading with code tabs.
- Fix hierarchy so that sidebar is actually useful.

Adding a top-level Android/iOS(Swift)/iOS(ObjC) switch is really, really
painful to do right now. What RN does for this is incredibly gross (sorry, but I'm sure they'd agree)
and precarious. It only takes one incorrectly placed newline to break everything.

Let's avoid that for now.

Reviewed By: jknoxville

Differential Revision: D15123871

fbshipit-source-id: b1184dbbaf3e38b09596ce4e0f0d4daa79b8e33f
2019-04-29 15:43:22 -07:00
Pascal Hartig
20bd937d43 Flipper Bump: v0.20.1-SNAPSHOT
Summary: Back to snapshots.

Reviewed By: danielbuechele

Differential Revision: D14951752

fbshipit-source-id: a0d0d12fc6f9eae3e7809d18df8ed1a85503f4e4
2019-04-17 10:37:33 -07:00
Pascal Hartig
6fa40aad77 Flipper Release: v0.20.0
Summary:
== Highlights

* Improved UI when exporting Flipper data. (45999a5292)

== Fixes

* The Shared Preference Plugin on Android will search for all shared pref files instead of only the package name by default. (825ecb8e23)
* When restarting Flipper and the previously selected plugin no longer exists, the UI would crash. (c4a8e73543)

Commit log: https://github.com/facebook/flipper/compare/v0.19.0...v0.20.0

Reviewed By: danielbuechele

Differential Revision: D14951753

fbshipit-source-id: dbafc2d41cd25b2ede218b3fe3e99745226939a9
2019-04-17 10:37:33 -07:00
Pritesh Nandgaonkar
8a19a859f2 Update Componentkit, Yoga, YogaKit
Summary: Fixed the broken master for flipper iOS  oss

Reviewed By: jknoxville

Differential Revision: D14686908

fbshipit-source-id: abdcacf279449f83c98d1635c65ff8759ee17926
2019-04-01 06:59:59 -07:00
Pascal Hartig
6ba28232ce Flipper Bump: v0.19.1-SNAPSHOT
Summary: Reenable snapshots.

Reviewed By: priteshrnandgaonkar

Differential Revision: D14665280

fbshipit-source-id: 3d89cb2d51ceaf6fc612eb1008eb8201a5af4554
2019-03-28 08:29:51 -07:00
Pascal Hartig
9ff6cfa9a4 Flipper Release: v0.19.0
Summary:
== Highlights

- **Layout 2.0**: We have a new layout inspector that was rewritten from the ground to address all sorts of small bugs that like nodes not expanding that should all be gone now.
- **New Crash Reporter**: Flipper will now detect crashes on your device and give you easy access to them through a device plugin that you can find next to logs. Learn more at https://fbflipper.com/docs/crash-reporter-plugin.html.
- **Import/Export**: You can now import and export Flipper sessions as data to share them with others. Learn more at https://fbflipper.com/docs/share-flipper-data.html.

== Fixes

- Improved error reporting for what was previously summarised under "RecurringError". (bf9be74ad2)
- Fixed an issue where the color picker could get cut off. (f9ec0cd326) (https://github.com/facebook/flipper/issues/396)

Full list: https://github.com/facebook/flipper/compare/v0.18.0...v0.19.0

Reviewed By: priteshrnandgaonkar

Differential Revision: D14665281

fbshipit-source-id: 78ed042d38642356180f25455d0d17a03ed59c6b
2019-03-28 08:29:51 -07:00
Pritesh Nandgaonkar
d9354fa484 Update Documentation
Summary: Updated documentation and screenshot for the new revamped UI

Reviewed By: passy

Differential Revision: D14643273

fbshipit-source-id: b05e19bcf42d00ce61a7cf61f93cbcd1d1f07a20
2019-03-28 04:37:54 -07:00
Pritesh Nandgaonkar
fd9b581162 Documentation for sharing flipper data
Summary: Added documentation for the Flipper's Import/Export feature

Reviewed By: passy

Differential Revision: D14539133

fbshipit-source-id: 66f85c46edd4ca644d2bbcd6e47dd9c88aa3618c
2019-03-20 06:59:28 -07:00
Pascal Hartig
2813b584f6 Flipper Bump: v0.18.1-SNAPSHOT
Summary: Reenable snapshots.

Reviewed By: jknoxville

Differential Revision: D14477604

fbshipit-source-id: a71d49f2228b8f91b22ac5f8f1afc0444b77b32b
2019-03-15 08:51:09 -07:00
Pascal Hartig
c7633cb585 Flipper Release: v0.18.0
Summary:
= Highlights

This is a bit of a boring release, to be frank. Most of the stuff happened behind the scenes, but a lot of preparation for interesting stuff happened behind the scenes, so stay tuned!

= Fixes

- Upgraded to Electron 4.0.8 (e0127b8438)
- Fixes to node expansion in the layout inspector.
- Connectivity improvements.

See https://github.com/facebook/flipper/compare/v0.17.1...v0.18.0 for reference.

Reviewed By: jknoxville

Differential Revision: D14477605

fbshipit-source-id: 0d927ba08fa5fab9d95c76ec763f5b9dd5bc104d
2019-03-15 08:51:09 -07:00
Pascal Hartig
44b7d4c6c3 Flipper Bump: v0.17.2-SNAPSHOT
Summary: Back to snapshot releases.

Reviewed By: danielbuechele

Differential Revision: D14384824

fbshipit-source-id: 7447732d299a2f85081ef1eec27f14416d88a3bc
2019-03-08 04:55:40 -08:00
Pascal Hartig
d025bbd0bf Flipper Release: v0.17.1
Summary:
== Bugfix Release ==

Fixes #394 in which using the network inspector can cause the plugin view to crash. Also fixes an issue where native background plugins can fail to connect (d720b20870).

Reviewed By: danielbuechele

Differential Revision: D14384823

fbshipit-source-id: 7cee49d22ec2ed8f076cf3aeb980d4ba3a273a3f
2019-03-08 04:55:40 -08:00
Pascal Hartig
e2eab5b0dc Update communicating.md (#392)
Summary:
Fix quotes
Pull Request resolved: https://github.com/facebook/flipper/pull/392

Reviewed By: danielbuechele

Differential Revision: D14342217

Pulled By: passy

fbshipit-source-id: 8e6fa9580ef42a69e709802edbbe85a163388425
2019-03-07 03:17:05 -08:00
Pascal Hartig
83aee0cd75 Update create-plugin.md (#391)
Summary:
Remove a broken link and some outdated information
Pull Request resolved: https://github.com/facebook/flipper/pull/391

Reviewed By: danielbuechele

Differential Revision: D14342219

Pulled By: passy

fbshipit-source-id: ab915618fe2ad3f955c465c091a636f9ea19ba33
2019-03-07 03:12:09 -08:00
Pascal Hartig
c2cc17833e Typos and corrections for troubleshooting docs
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/390

Reviewed By: danielbuechele

Differential Revision: D14342222

Pulled By: passy

fbshipit-source-id: 10509d3738a02136b378f6694c721fc72f0aeef0
2019-03-07 03:00:17 -08:00
Nicolas Hauseux
54d51cc30a small typo correction in android import
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/388

Differential Revision: D14341908

Pulled By: passy

fbshipit-source-id: dd5329c537311b37c4c39cf1dec4886f543a08d5
2019-03-06 07:30:24 -08:00
Pritesh Nandgaonkar
d8a1a80338 Flipper Bump: v0.17.1-SNAPSHOT
Summary: As per the title

Reviewed By: danielbuechele

Differential Revision: D14269566

fbshipit-source-id: 94bf552aa654199efddc49d4077da30915c9d387
2019-03-05 06:28:26 -08:00
Pritesh Nandgaonkar
88f976b09b Flipper Release: v0.17.0
Summary:
- The Android library now uses AndroidX instead of the support-library.
- Folly and RSocket dependencies uploaded to cocoapods (f8bd473828).

- Improved Unicode support in the Network Inspector plugin (f4b2ce9a2b).
- Fixed MacOS release creation.
- Several UI fixes regarding in-app search and the toolbar.

Reviewed By: passy

Differential Revision: D14269567

fbshipit-source-id: 2d2f965316bd1ddfb375a2db48fb715095693c43
2019-03-05 06:28:26 -08:00
John Knox
9c4aa9b9cb Call out SoLoader.init in getting started docs
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/383

Reviewed By: danielbuechele

Differential Revision: D14208864

Pulled By: jknoxville

fbshipit-source-id: 54a319a4b6a658ae49ed90223463ddf7a07bb9c7
2019-02-26 02:46:49 -08:00
Daniel Büchele
43157f974e Update docs to use package name as ID
Summary: We swtiched from using the name of the package as the ID which is used to identify a client plugin. These changes were not reflected correctly in our docs.

Reviewed By: jknoxville

Differential Revision: D14165439

fbshipit-source-id: 1cbb9c1723911f8fa4b7df19c631e6f260c81bd8
2019-02-21 09:39:54 -08:00