Commit Graph

100 Commits

Author SHA1 Message Date
John Knox
263aba9f31 Add custom edit url for ui-components page
Summary:
This page is auto generated, so the default link gives a 404.
Pointing it to the script instead.

Reviewed By: passy

Differential Revision: D21325554

fbshipit-source-id: 5ede07daa6335ad0199a11c5483e328c3ca2c5e3
2020-04-30 07:13:47 -07:00
Pascal Hartig
ac400e5420 Update homepage title
Summary:
It's currently a lower-case "index" which looks a bit off. :)

{F235813923}

Reviewed By: mweststrate

Differential Revision: D21324972

fbshipit-source-id: 6b75b23aa0122e2db08f7532205b6e07758155fc
2020-04-30 06:59:31 -07:00
John Knox
7e4682b694 Fix the remaining broken links on fbflipper.com
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
2020-04-29 07:33:43 -07:00
John Knox
b483e0688d Make h3 smaller than h2
Summary:
After moving to docusaurus v2, our h3 tags are bigger than the h2 tags.
Removing our custom css fixes this, so doing that to get closer to the default theme.

Reviewed By: mweststrate

Differential Revision: D21283840

fbshipit-source-id: ceaf7488b90bbb90a463037d9e1dfcca1d694366
2020-04-28 17:33:25 -07:00
Anton Nikolaev
21c574ac80 "lint" command for flipper-pkg tool
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
2020-04-27 17:34:11 -07:00
John Knox
5f1a0548f5 Migrate website to Docusaurus 2
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
2020-04-27 04:05:01 -07:00
Anton Nikolaev
e165c2cd95 Desktop plugin development workflow
Summary: Updated docs describing workflow for creating Flipper desktop plugins

Reviewed By: passy

Differential Revision: D21129688

fbshipit-source-id: 68921e5d3784e3ab6b3e8397199b10101348a86a
2020-04-23 05:58:39 -07:00
John Knox
a5dbfbb82d Fix UI-doc generation
Summary: I noticed the UI components page was empty, the components have been moved and the generator was still looking in the old place.

Reviewed By: passy

Differential Revision: D21131943

fbshipit-source-id: 3310d4f7c88ea0f1e77a13c81eb411f9b1475125
2020-04-20 09:41:42 -07:00
Pascal Hartig
f3bb94fd7c Fix getting-started link (#1005)
Summary:
Fixes https://github.com/facebook/flipper/issues/1003
Pull Request resolved: https://github.com/facebook/flipper/pull/1005

Test Plan: https://fbflipper.com/docs/getting-started/index.html works.

Reviewed By: jknoxville

Differential Revision: D20993208

Pulled By: passy

fbshipit-source-id: 1f0e3dd9a8d13f76018117dbc73dd1513a0df3c2
2020-04-14 07:56:26 -07:00
Pascal Hartig
2823307c62 Add RN Android/iOS docs
Summary:
I trimmed the previous versions of this down a lot to only
focus on what RN developers need to know without duplicating
what we have in the non-RN docs.

Reviewed By: mweststrate

Differential Revision: D20816115

fbshipit-source-id: 9d88a6fb0d49e823194cce647e64b86d61d6229a
2020-04-06 08:27:20 -07:00
Pascal Hartig
83fd17898f Bump minimist
Summary:
Another day ending in y, another minimist vulnerability. Bumping
to `1.2.3`.

(Note: this ignores all push blocking failures!)

Reviewed By: cekkaewnumchai

Differential Revision: D20860264

fbshipit-source-id: 569abd7e521efef92cd0b31113e0325493645c2a
2020-04-06 03:11:04 -07:00
Pascal Hartig
3168fb1c0e Pin kind-of
Summary:
Got an open security alert for this one.

(Note: this ignores all push blocking failures!)

Reviewed By: cekkaewnumchai

Differential Revision: D20840586

fbshipit-source-id: b57fda5a7c3244c7bf893082896ea8d1ee138493
2020-04-06 03:11:04 -07:00
John Knox
f1e8297800 Fix broken links on website and github readme
Summary:
The url for the getting started page was changed yesterday. (no longer getting-started.html)
This fixes some links that were broken because of it.

Reviewed By: cekkaewnumchai

Differential Revision: D20855343

fbshipit-source-id: 788efb75f3581e4fe6cecd5f69f11dd64b03e7df
2020-04-04 02:30:52 -07:00
Pascal Hartig
0a68044649 Split up getting started docs
Summary:
This is a first step in breaking up the getting started docs.
Ultimately, the React Native Android and iOS bits will become
separate sections, too, but I won't to keep the diffs a bit smaller.
This one doesn't really do much apart from reorganising the current
content.

Reviewed By: mweststrate

Differential Revision: D20815235

fbshipit-source-id: 5c85b788211699a2a9f5808b9e2590c7db68a1c1
2020-04-03 06:17:49 -07:00
Pascal Hartig
7e9e7c2fe9 Mention RN right at the top
Summary: RN is first class.

Reviewed By: jknoxville

Differential Revision: D20693739

fbshipit-source-id: a9eabbcb25254dfaf0e31a252bf67eae22390010
2020-03-27 10:36:15 -07:00
Pascal Hartig
35145ae645 Upgrade deps (#930)
Summary:
Solves another acorn/minimist sec vuln. Also removed pins which
don't seem to be necessary anymore based on `yarn.lock` output
which seems to just remove them.
Pull Request resolved: https://github.com/facebook/flipper/pull/930

Test Plan: Ran `yarn build` and it still looks fine.

Reviewed By: mweststrate

Differential Revision: D20669831

Pulled By: passy

fbshipit-source-id: 8d82678cfac6304273aaf752b885edac91e0a8eb
2020-03-26 10:09:32 -07:00
Michel Weststrate
8060bcb664 Add feature page for react native integration
Summary: https://pxl.cl/144pb

Reviewed By: jknoxville

Differential Revision: D20648205

fbshipit-source-id: 1349723755ed2be5b577f42ec1e45df07c25c94f
2020-03-25 15:36:22 -07:00
John Knox
0275d35233 Add lifecycle diagrams for regular and background plugins
Summary:
I think this'll clarify how to use the lifecycle methods.

Diagram edit link: https://excalidraw.com/#json=5696112581148672,nDwD6t1BNXVreQ8YE8917g

Reviewed By: mweststrate

Differential Revision: D20645302

fbshipit-source-id: 0814dbe8421cfe8e85c297bd5bfb4a8f1a83c353
2020-03-25 12:50:29 -07:00
greenkeeper[bot]
912cd1f2c3 Greenkeeper/website/react docgen 5.2.1 (#799)
Summary:
Fix https://github.com/facebook/flipper/issues/782
Pull Request resolved: https://github.com/facebook/flipper/pull/799

Reviewed By: mweststrate

Differential Revision: D19902542

Pulled By: passy

fbshipit-source-id: 01d71b27492a7eb0a17b4c4ac370abcdd95cab3e
2020-02-14 13:07:14 -08:00
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