Commit Graph

81 Commits

Author SHA1 Message Date
John Knox
c2ed83c70d Upgrade react-docgen
Summary: Fixes #781

Reviewed By: passy

Differential Revision: D19815114

fbshipit-source-id: 2c223ceaaa5d9b5e47bdaf8c705db2eef527339f
2020-02-10 18:43:00 -08:00
Michel Weststrate
426d17b08d Update docs for JS only plugins
Summary: Added docs on how to write React-Native JavaScript based plugins

Reviewed By: passy

Differential Revision: D19344803

fbshipit-source-id: ad1ea66f1031760729fdaea8a7e6c1ef5dcd5439
2020-01-23 07:11:31 -08:00
Chaiwat Ekkaewnumchai
3fab1f8fd6 Upgrade Babel
Summary: Update babel related dependency to 7.8.3

Reviewed By: passy

Differential Revision: D19408069

fbshipit-source-id: cc9beca6bb9c8d2102332dac3812f52ca7275ec0
2020-01-16 03:58:32 -08:00
greenkeeper[bot]
021301e5aa Greenkeeper/website/monorepo.babel7 20191208003358 (#692)
Summary:
Fix https://github.com/facebook/flipper/issues/680
Pull Request resolved: https://github.com/facebook/flipper/pull/692

Reviewed By: mweststrate

Differential Revision: D18929821

Pulled By: passy

fbshipit-source-id: 6de0f6c505eb998de25035686e7a52ed8fdb4d06
2019-12-11 09:45:48 -08:00
Nicolas Charpentier
201203ab84 Refresh Getting Started with the latest React Native integration (#676)
Summary:
Sync the Getting Started section about React Native integration with the latest changes in https://github.com/facebook/react-native/pull/27426.

## Changelog

Refresh Getting Started with the latest React Native integration
Pull Request resolved: https://github.com/facebook/flipper/pull/676

Test Plan: Tested in RN's template.

Reviewed By: mweststrate

Differential Revision: D18853584

Pulled By: passy

fbshipit-source-id: d001046106743b68d2f08b084c7618d8f768dea1
2019-12-10 06:07:03 -08:00
Pascal Hartig
63959c275c Lock ws to 3.3.1
Summary:
Long-standing 'security' issue. Doesn't matter for a static
site generator with controlled input, of course, but
we're failing our OSS validation if we just dismiss it.

Reviewed By: cekkaewnumchai

Differential Revision: D18638722

fbshipit-source-id: d8636dee67826c4e453ac0f74cd3dfa8f77ba0dd
2019-11-21 08:39:07 -08:00
greenkeeper[bot]
be36aa4bc1 Greenkeeper/website/monorepo.babel7 20191108210517 (#637)
Summary:
Upgrading babel.
Pull Request resolved: https://github.com/facebook/flipper/pull/637

Reviewed By: jknoxville

Differential Revision: D18474995

Pulled By: passy

fbshipit-source-id: fb6bb724e4431b85bf8a503d32d9480aeaa28239
2019-11-13 03:04:26 -08:00
Michel Weststrate
2f5096ddc8 Improve setup documentation
Summary:
Random observations

1. RN already generates the Flipper initialization code out of the box
2. This code assumes a prefixed namespace: `facebook.flipper`. Maybe it would be better if that were `appname`, but that seems an unnecessary burden at this point, preventing direct copy / paste possibilities
3. Out of the box, the generated code by RN doesn't align with the code provided here, because no `ReactInstanceManager` argument is passed in (nor does it seem to be available in a straight-forward way)
4. patch MainApplication.java with `getReactNativeHost().getReactInstanceManager()`
5. turn this into an explicit section: https://fbflipper.com/docs/tutorial/js-table.html#dynamic-plugin-loading. Also explain that when using `node_modules`, config doesn't need to be changed?
6. xcode 10! sudo xcode-select -s /Applications/Xcode_10.XXX/Contents/Developer/
7. Also tried to install Reactotron plugins by Infinite Red, got that compilable in the end, but the andoid / ios implementations still seems to be stub, so I'll try to follow up with them later, to be notified when they actually have something

Reviewed By: passy

Differential Revision: D18349098

fbshipit-source-id: 233bbe20a37c57c7dfe08c8fccdd4508bdefe96f
2019-11-08 04:40:27 -08:00
John Knox
c1b320be6e Move "Download" out of the Mac button on front page
Summary:
This didn't look quite right to me, "Download Mac", "Linux", "Windows".
Changed it to a separate "Download for", with "Mac", "Linux" and "Windows" buttons.

Reviewed By: passy

Differential Revision: D18225271

fbshipit-source-id: d644570d072029fc792cd9d9c18d8616ada0017b
2019-10-30 11:23:28 -07:00
Andres Suarez
54ebb44dda Tidy up Flipper license headers [2/2]
Reviewed By: passy

Differential Revision: D17863710

fbshipit-source-id: 5b249bdd1c06d3a526b250b035b797d0c8e796eb
2019-10-11 13:46:45 -07:00
Andres Suarez
0675dd924d Tidy up Flipper license headers [1/2]
Reviewed By: passy

Differential Revision: D17863711

fbshipit-source-id: 259dc77826fb803ff1b88c88529d7f679d3b74d8
2019-10-11 13:46:45 -07:00
Pascal Hartig
83ad3b956a Upgrade website dependencies
Summary:
Got a warning during `yarn start` that the caniuse database
was out of date so I updated it along with the rest.

allow-large-files

Reviewed By: jknoxville

Differential Revision: D17715099

fbshipit-source-id: 8ff705afbaa0f2be272f85e2996d8e32c1f6ab05
2019-10-03 07:47:34 -07:00
Pascal Hartig
9bce894b71 Add publishing/installing docs
Summary:
Adding publishing and installation procedure docs to
our tutorial to round things off.

Reviewed By: jknoxville

Differential Revision: D17711800

fbshipit-source-id: 57c848c559208eb2a0ca790a72bcd493730baf16
2019-10-02 08:56:38 -07:00
Pascal Hartig
6b58e813e5 Add GA
Summary: Add Google Analytics code.

Reviewed By: danielbuechele

Differential Revision: D17398649

fbshipit-source-id: 79acd7a9d3ac19a25deea3f84989860308f2787e
2019-09-17 03:12:18 -07:00
Pascal Hartig
7e0b66ae8e Add linux/windows download buttons
Summary:
There's probably a more elegant way for doing this
so please let me know if you can think of something.

Reviewed By: danielbuechele

Differential Revision: D17318727

fbshipit-source-id: 9afcc30205171cfb07f0a749c552692cb40a3ced
2019-09-12 08:12:43 -07:00
Daniel Büchele
98b4071242 react-docgen for TypeScript
Summary: Update react-docgen to support TypeScript

Reviewed By: passy

Differential Revision: D17204178

fbshipit-source-id: 408ce5569a253c9a836f65bd9a9f289cc82b5175
2019-09-05 07:43:11 -07:00
dependabot[bot]
74562148f8 Bump mixin-deep from 1.3.1 to 1.3.2 in /website (#529)
Summary:
Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2.
<details>
<summary>Commits</summary>

- [`754f0c2`](754f0c20e1) 1.3.2
- [`90ee1fa`](90ee1fab37) ensure keys are valid when mixing in values
- See full diff in [compare view](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2)
</details>
<details>
<summary>Maintainer changes</summary>

This version was pushed to npm by [doowb](https://www.npmjs.com/~doowb), a new releaser for mixin-deep since your current version.
</details>
<br />

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mixin-deep&package-manager=npm_and_yarn&previous-version=1.3.1&new-version=1.3.2)](https://help.github.com/articles/configuring-automated-security-fixes)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

 ---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `dependabot rebase` will rebase this PR
- `dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `dependabot merge` will merge this PR after your CI passes on it
- `dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `dependabot cancel merge` will cancel a previously requested merge and block automerging
- `dependabot reopen` will reopen this PR if it is closed
- `dependabot ignore this [patch|minor|major] version` will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
- `dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/facebook/flipper/network/alerts).

</details>
Pull Request resolved: https://github.com/facebook/flipper/pull/529

Reviewed By: danielbuechele

Differential Revision: D17095288

Pulled By: passy

fbshipit-source-id: 6433300f18828c7e7c117e25821b69c6b6fb5def
2019-09-02 06:15:57 -07:00
Benjamin Elo
6b93cd15c2 Added docs for open source Navigation Plugin
Summary:
Added docs for the Navigation Plugin.

I've added instructions on how to use the plugin with vanilla Android, or how to integrate it with a third party solution.

Reviewed By: danielbuechele

Differential Revision: D16856614

fbshipit-source-id: e99cb94318820bd926f50bd4ba205fb11396a9d8
2019-08-16 07:29:18 -07:00
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
Pascal Hartig
145e872be1 Upgrade docusaurus
Summary: Just a minor version change, no changes expected.

Reviewed By: jknoxville

Differential Revision: D15897958

fbshipit-source-id: b103772159177e47884eb88e47f7b4077f77be03
2019-06-20 03:51:17 -07:00
Pascal Hartig
66c52930f2 Force newer underscore.string version
Summary:
To fix security alert from GitHub:

https://github.com/facebook/flipper/network/alert/website/yarn.lock/underscore.string/open

Reviewed By: jknoxville

Differential Revision: D15851515

fbshipit-source-id: ce9ca1543f9315c38c73b92fd84b8376283eb7bb
2019-06-17 04:47:23 -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
Pascal Hartig
dabf1a5cf9 Fix broken link on Getting Started
Summary: The "next" link at the bottom right now leads to a 404 (was the old data page).

Reviewed By: jknoxville

Differential Revision: D15237635

fbshipit-source-id: 67ee7ace933d270b9e85b012e9128e1003c73ece
2019-05-07 09:56:51 -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
Pascal Hartig
6dda7d2b63 More headers
Reviewed By: jknoxville

Differential Revision: D15199272

fbshipit-source-id: d46355a284a6e2acdaccd622dfd4419b06e61a61
2019-05-03 12:08:04 -07:00
Pascal Hartig
b3b75939a8 Reorganise extend sidebar
Summary:
- Layout was in an odd spot. "Other platforms" is still weird, but it's at least next to the JS part now.
- Tutorial is the first thing after the intro.

Reviewed By: danielbuechele

Differential Revision: D15198470

fbshipit-source-id: 263582ee51f228a295be5952f5dc219e53c5e3e6
2019-05-03 10:21:22 -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
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
733d61132e Restore UI components page in sidebar
Summary: This was missing because it was still being generated in /docs.

Reviewed By: danielbuechele

Differential Revision: D15198144

fbshipit-source-id: aa9e77a1603fb63c1a7576091b70d8fa7124ab16
2019-05-03 07:10:57 -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
Pascal Hartig
adba73ba3c Increase top padding for code buttons
Summary: priteshrnandgaonkar pointed out that they sometimes overlap with the text.

Reviewed By: jknoxville

Differential Revision: D15182356

fbshipit-source-id: def39676d5dcce85aa0b41760cec0ec5cfb9398c
2019-05-02 10:59:13 -07:00
John Knox
cf9807d432 Fix broken footer links
Summary: n/a

Reviewed By: danielbuechele

Differential Revision: D15182819

fbshipit-source-id: b2a76dfe94af1ecd9c6fc0c5831ae02fc1fde73f
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
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
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
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
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