Commit Graph

405 Commits

Author SHA1 Message Date
Pascal Hartig
9e13b90708 Add setup docs for Fresco/Images
Summary: Per title.

Reviewed By: danielbuechele

Differential Revision: D15898614

fbshipit-source-id: b2d86a58e80b1309159bc738bcc66ca09cd796ad
2019-06-20 03:51:18 -07:00
Pascal Hartig
aae6a7f109 Add docs for fresco plugin
Summary:
Now that we finally have something we can screenshot ...

Just for the features page right now, will add some
"installation" instructions next.

Reviewed By: oprisnik

Differential Revision: D15898050

fbshipit-source-id: 9dfd3b1121799e7069336aac845ba2abdb3e42df
2019-06-20 03:51:18 -07:00
Arnaud Frugier
fa887f4f12 Add documentation for Databases Plugin
Summary: ^^

Reviewed By: jknoxville

Differential Revision: D15666190

fbshipit-source-id: 4b2f5c5544820baa4654b4e52a7e75bd275facc1
2019-06-06 11:17:19 -07:00
John Knox
0d08d2b3b0 Flipper Bump: v0.21.2-SNAPSHOT
Summary: Database plugin bug fixes.

Reviewed By: priteshrnandgaonkar

Differential Revision: D15557872

fbshipit-source-id: 2f19d34d38669e556024bd87055591a4ab1c3389
2019-05-30 14:29:12 -07:00
John Knox
69c38b3a26 Flipper Release: v0.21.1
Summary: Database plugin bug fixes

Reviewed By: priteshrnandgaonkar

Differential Revision: D15557874

fbshipit-source-id: 0776f2e983919f29268e094d7c760410c9c0197f
2019-05-30 14:29:12 -07:00
Pascal Hartig
915b140756 Flipper Bump: v0.21.1-SNAPSHOT
Summary: Back to snapshots.

Reviewed By: jknoxville

Differential Revision: D15518398

fbshipit-source-id: 2823118c160a137b43470a6d0910d76c86a6558e
2019-05-28 10:22:16 -07:00
Pascal Hartig
c8965d389d Flipper Release: v0.21.0
Summary:
# Highlights

- Revamped documentation! We redesigned https://fbflipper.com/ and hope you like it. We added new tutorials, feature pages and way too many things to list here.
- `no-op` package for Android makes it easier to (not) ship Flipper with production releases.
- "Copy as cURL" support for the network plugin (https://github.com/facebook/flipper/pull/415)

Reviewed By: danielbuechele

Differential Revision: D15518400

fbshipit-source-id: 041cc546f4bfd70b13d9bb25eaa6eecf5dc1d7f9
2019-05-28 10:22:16 -07:00
Pritesh Nandgaonkar
2ec6f14759 Flipper Bump: v0.20.4-SNAPSHOT
Summary: Making a release to test the automated pods publishing. The last one failed, due to the wierd Sandcastle bug

Reviewed By: passy

Differential Revision: D15373866

fbshipit-source-id: 644bf24e28d712c40a053623fc2b80bf6b011fde
2019-05-16 10:05:24 -07:00
Pritesh Nandgaonkar
c08032cc51 Flipper Release: v0.20.3
Summary: Making a release to test the automated pods publishing. The last one failed, due to the wierd Sandcastle bug

Reviewed By: passy

Differential Revision: D15373868

fbshipit-source-id: a4e0eb0720f634c5667304f84b0fdaf26060d563
2019-05-16 10:05:24 -07:00
Pascal Hartig
2aabfd98e4 Update search-and-filter.md (#449)
Summary:
Fix some minor typos.
Pull Request resolved: https://github.com/facebook/flipper/pull/449

Reviewed By: danielbuechele

Differential Revision: D15371603

Pulled By: passy

fbshipit-source-id: a64a64039a9275d9b8fce82cb06cec0627bb9af8
2019-05-16 04:22:16 -07:00
Pritesh Nandgaonkar
d7d455191c Flipper Bump: v0.20.3-SNAPSHOT
Summary: Want to make a release to test out the automated release of pods to cocoapods.

Reviewed By: jknoxville

Differential Revision: D15358712

fbshipit-source-id: 9430b7d2f16e3a2df498cc2359bbef7e7d1a3f18
2019-05-16 03:41:55 -07:00
Pritesh Nandgaonkar
a149feb768 Flipper Release: v0.20.2
Summary: Want to make a release to test out the automated release of pods to cocoapods.

Reviewed By: jknoxville

Differential Revision: D15358714

fbshipit-source-id: 08971164cb7c4a27646f3614669ae7cb9e4d6265
2019-05-16 03:41:55 -07:00
Pascal Hartig
3747b15d7b Update styling-components.md (#447)
Summary:
Link to color definitions.
Pull Request resolved: https://github.com/facebook/flipper/pull/447

Reviewed By: danielbuechele

Differential Revision: D15353434

Pulled By: passy

fbshipit-source-id: e1a15ae4979956f2b0529ee86e0a523a93d77006
2019-05-16 02:42:37 -07:00
Pascal Hartig
2b6888b0d3 Update share-flipper-data.md (#446)
Summary:
It looked like the "..." was meant as a placeholder?
Pull Request resolved: https://github.com/facebook/flipper/pull/446

Reviewed By: danielbuechele

Differential Revision: D15337644

Pulled By: passy

fbshipit-source-id: 89d4d15d1448d8c61997341b5bfd67f2adb6a021
2019-05-15 03:51:30 -07:00
Daniel Büchele
3df970a7d3 docs: add debugging info
Summary: Adds troubleshooting infos for issues like https://github.com/facebook/flipper/issues/444

Reviewed By: passy

Differential Revision: D15335814

fbshipit-source-id: 96969d61a6842c86123b77817059340fec38a665
2019-05-15 02:53:49 -07:00
Pascal Hartig
680a6040bb Update stetho.md (#437)
Summary:
Capitalising some names and fixing typos.
Pull Request resolved: https://github.com/facebook/flipper/pull/437

Reviewed By: priteshrnandgaonkar

Differential Revision: D15258308

Pulled By: passy

fbshipit-source-id: 74ecbc35e8979fbcbc85aa0e81183190169388ab
2019-05-08 09:14:20 -07:00
Pascal Hartig
94f4a7261f Update sandbox-plugin.md (#438)
Summary:
Simplify wording a bit.
Pull Request resolved: https://github.com/facebook/flipper/pull/438

Reviewed By: priteshrnandgaonkar

Differential Revision: D15258346

Pulled By: passy

fbshipit-source-id: 98e7b6bd190e90e9f5e63d9522dc880f54f72168
2019-05-08 09:08:26 -07:00
Pascal Hartig
484f38a814 Update logs-plugin.md (#435)
Summary:
Fix some typos.
Pull Request resolved: https://github.com/facebook/flipper/pull/435

Reviewed By: jknoxville

Differential Revision: D15239797

Pulled By: passy

fbshipit-source-id: baf0518f10998bb8027dcdf97490452aff101a42
2019-05-07 10:32:50 -07:00
Pritesh Nandgaonkar
a89b732765 Fix typo
Summary: Fixes a typo

Reviewed By: jknoxville

Differential Revision: D15200593

fbshipit-source-id: baf5679e095e7bc430f56de03793033c16d59f5f
2019-05-07 04:08:50 -07:00
Pritesh Nandgaonkar
0c54699371 iOS tutorial setup
Summary:
I copied the wordings from Pascal's android setup and changed the API's to match the iOS one. 🙈
This doc explains how to build custom plugin in iOS

Reviewed By: passy

Differential Revision: D15200426

fbshipit-source-id: 0a3c966f7c74aae410c6b3ee643e5a38d33880de
2019-05-07 04:08:50 -07:00
Daniel Büchele
f3876fbaad update custom JS tutorial
Summary: Update according to changes in D15200794

Reviewed By: jknoxville

Differential Revision: D15200901

fbshipit-source-id: ef0e0895f30d6eb98536c9a7df7a0d46bb4af8d2
2019-05-03 16:24:51 -07:00
John Knox
37101cd1a7 Tidy up error handling page
Summary: Some wording corrections, and added FlipperResponder section.

Reviewed By: passy

Differential Revision: D15200397

fbshipit-source-id: 2d52b1d7cb55b4cb8b0e15f00242201edf520f16
2019-05-03 10:29:43 -07:00
Pascal Hartig
531b5e850c JS custom UI tutorial
Summary:
- Adding tutorial for custom JS UI
- optimizing screenshots
- fixing overlapping screenshots on landing page

Reviewed By: jknoxville

Differential Revision: D15198105

fbshipit-source-id: db53403b84a2c422650a4f80e959dad6e984d274
2019-05-03 10:21:22 -07:00
Pascal Hartig
1afece19e7 JS table tutorial
Summary: Image is a placeholder, again.

Reviewed By: jknoxville

Differential Revision: D15185033

fbshipit-source-id: 6c60709d35da97c41a7c4328ef597747d6cea389
2019-05-03 10:21:21 -07:00
Pascal Hartig
2b0e91aa69 Add tutorial section and Android part
Summary:
JS is next. Screenshot on the intro page is really bad.
I hope danielbuechele can replace this. :)

Reviewed By: jknoxville

Differential Revision: D15184371

fbshipit-source-id: 2faaf46450d192ae400675c13b8d71fa1b7dab14
2019-05-03 10:21:21 -07:00
Pritesh Nandgaonkar
a8e7f0e028 Updated the installation instruction for swift projects with use_framework
Summary: As per the title. This diff tackles the installation issue for swift projects with `use_framework!`. For more information on this bug follow the discussion [here](https://github.com/facebook/flipper/issues/254)

Reviewed By: danielbuechele

Differential Revision: D15198527

fbshipit-source-id: 573d328369d4bf566ed89f707ed2d6902da0443a
2019-05-03 09:53:52 -07:00
John Knox
c866ba9428 Fix website yarn start
Summary: Inlining the component docs header instead of reading it from the same file we write to.

Reviewed By: passy

Differential Revision: D15199683

fbshipit-source-id: dc34e25b5f8073aa582f90a14bc875c8e8c431db
2019-05-03 09:47:59 -07:00
John Knox
23b35e8006 Add debugging page
Summary: Information about debugging.

Reviewed By: passy

Differential Revision: D15198711

fbshipit-source-id: 587bca43d99908b666c58bb5279fadb61219e9a1
2019-05-03 09:47:59 -07:00
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