Commit Graph

45 Commits

Author SHA1 Message Date
Michel Weststrate
df7941e2bc deprecated Searchable abstraction
Summary: Since the functionality is now available as part of DataTable, the HoC doesn't seem to be needed as generic abstraction. it is used in handful places outside datatable / datalist, but those can be localized in the future or should datatable / datalist.

Reviewed By: fabiomassimo

Differential Revision: D28993836

fbshipit-source-id: 3e6da7c7b48348faa0c4f7281868196f5585a065
2021-06-10 04:45:18 -07:00
Michel Weststrate
a0c872dd38 Update setup and createTable tutorial to 100% Sandy
Summary:
The current desktop plugin tutorial was outdated as it has several steps that are now automated, and still referred to old APIs. This has been updated now.

Additionally left the intermediate code of the tutorial in the plugin, but splitting `index.tsx` into `index_table.tsx` and `index_custom.tsx` (which will be updated in the next diff)

Clarified the tutorial page labels a little bit to show that 3 pages are covering the Desktop plugin development process.

Changelog: Updated the Desktop plugin tutorial

Reviewed By: jknoxville

Differential Revision: D28990029

fbshipit-source-id: a06a7a774ceca3daf10f8e8fbd4e03191dbfd1cc
2021-06-09 07:26:57 -07:00
Pascal Hartig
4cdc72aba4 Add error logging doc
Summary: Lightweight docs about error logging.

Reviewed By: nikoant, priteshrnandgaonkar

Differential Revision: D28474066

fbshipit-source-id: 0527ab82d4fd084fc2ed88328e88db14f6ee4184
2021-05-18 11:23:05 -07:00
Michel Weststrate
3af41bfdd1 Add migration guide to convert from classic to Sandy plugins
Summary: Added migration guide from classic to Sandy plugins

Reviewed By: passy

Differential Revision: D27908674

fbshipit-source-id: d4b5a0b45e314226825375d762902041f90c04c8
2021-04-23 01:55:54 -07:00
Pritesh Nandgaonkar
6479c7e642 Add documentation for www certificate exchange
Summary: Adds documentation regarding www certificate exchange.

Reviewed By: jknoxville

Differential Revision: D27592932

fbshipit-source-id: 2284f77c6bf4fdd638588e2272598cb4ef370526
2021-04-06 09:09:05 -07:00
John Knox
b6fc2f0651 Fix duplicate route to setup/leak-canary-plugin
Summary:
Noticed this when building the site. Shame it only warns and doesn't fail the build.
Just fixing it while I'm here.

{F479009268}

Reviewed By: nikoant

Differential Revision: D26911725

fbshipit-source-id: 6440a4b8aee4a6bc053ae771a3b148fd70ffc298
2021-03-09 05:43:29 -08:00
Pritesh Nandgaonkar
cd02bb7fcb Add a doc explaining how to connect to flipper
Summary: This diff adds documentation for using physical devices to connect to Flipper. It also talks about simulators and emulators

Reviewed By: jknoxville

Differential Revision: D26780077

fbshipit-source-id: 47a08cec55c510abd36c2fc776f4ce05ff0ea4d0
2021-03-03 12:53:18 -08:00
Pascal Hartig
f10f963ff1 Add sandcastle tech talk as doc
Reviewed By: fabiomassimo

Differential Revision: D26460572

fbshipit-source-id: d5faf3af1424b271b14e6754c73d5995332abbfc
2021-02-16 07:42:23 -08:00
John Knox
3bf9bcc275 Reorganise the sdk installation sidebar
Summary:
Give the sdk installation pages a bit more structure.
To me it's much clearer now what they are.

Happy to hear differing opinions so we get it right :)

Reviewed By: passy

Differential Revision: D25638164

fbshipit-source-id: 86b7fecd8aba0068336b15a308f4a9433817c68e
2020-12-18 09:22:05 -08:00
John Knox
2f9d4280c1 Improve installation/update instructions
Summary:
The installation instructions didn't flow very well.

"Using flipper at Facebook" is now gone. It's installation steps have been moved into the desktop app page, with internal/external switching.

I've also removed the "Updating Flipper" internal page, and put equivalent info in the installation section.

Reviewed By: nikoant

Differential Revision: D25637831

fbshipit-source-id: 2af2abf57793d54804f5c45e3335b8641743e1c8
2020-12-18 09:22:05 -08:00
John Knox
77ffe1d47b Rename FB Internal to Under the Hood
Summary:
I think there's a need for an "implementation details" section of the site. Especially as we're moving the rest of our wiki content there.

I see it as a good thing, because now we have a place for implementation details relevant to OSS contributors too, it's not all fb-specific.

Reviewed By: nikoant

Differential Revision: D25614909

fbshipit-source-id: 5ec081e6450a9ad1c30785ae4cca74b6fa0d2630
2020-12-17 08:32:51 -08:00
John Knox
df99ba3606 Add internal wiki pages
Summary:
Ran the wiki migration script on the Flipper_Internals wiki.

Deleted the pages mentioned in https://www.internalfb.com/tasks/?t=81712504
Also deleted hacking-launcher, which is now succeeded by the new "hacking-on-launcher".

Reviewed By: nikoant

Differential Revision: D25613387

fbshipit-source-id: b57b3e20f37b556774d7748477a1dbb7fe844812
2020-12-17 08:32:50 -08:00
Michel Weststrate
69dae5c8e5 Restructured dev workflow docs
Summary: This diff unifies setup and workflow information that was scattered a bit around into one cohesive 'Development workflow' subsection in the 'creating plugins' section of Flipper.

Reviewed By: nikoant

Differential Revision: D25612288

fbshipit-source-id: 5fa7f2d000fb7ab3e1b5c5a4fc8cc1f209252f41
2020-12-17 07:40:58 -08:00
Michel Weststrate
19ea20511c Unify documentation on how to get a plugin instance
Summary: There were 3 pages describing how to obtain a plugin instance, public, ios and android. iOS didn't differ from the public one, and android only in the fact that internally DI is available. So combined the pages with just an optional section for DI inside FB on Android.

Reviewed By: jknoxville

Differential Revision: D25588057

fbshipit-source-id: 3a54ae699130a4c5ba018220708f844a35a8d6a9
2020-12-17 05:07:11 -08:00
Michel Weststrate
51995776d4 Combine client testing documentation
Summary: There was one public page for testing client plugins, and two internal ones. Combined it into a one pager, that has tabs per target, with separate content for internal versus external (didn't combine those as the testing frameworks recommended differ)

Reviewed By: nikoant

Differential Revision: D25588058

fbshipit-source-id: afa151ec0c3a5de26142938d3d389627716f1ff7
2020-12-17 05:07:11 -08:00
Michel Weststrate
a9ad932955 Combine the two pages describing sending data
Summary: send data was documented twice, in the general client API, and in the internal docs where it was specifically combined with obtaining a plugin instance. However, that is a proper public API as well, so combined those two.

Reviewed By: nikoant

Differential Revision: D25588059

fbshipit-source-id: 7135a74b64a87d0c8c3f8f20f7f260469f52d41c
2020-12-17 05:07:11 -08:00
John Knox
e1edd62c30 Move fb/plugins to Features section
Summary:
Moving this file outside of the "FB Internal section" so we can get rid of it.

I think this file can probably be replaced by the "flipper marketplace" at some point, driven programatically by package.json files etc, but I'm not sure if such a page exists at the moment.

Reviewed By: passy

Differential Revision: D25588707

fbshipit-source-id: 0809c21b30410252ef146cfcd161b836849dbbf0
2020-12-16 10:37:34 -08:00
Pascal Hartig
2751feadd0 Add new Launcher hacking docs
Summary:
The old Wiki (https://www.internalfb.com/intern/wiki/Flipper_Internals/hacking-launcher/)
is still mostly accurate but contains a lot of information about the deprecated Dewey pipeline.

Reviewed By: mweststrate

Differential Revision: D25586307

fbshipit-source-id: 82345510e19986f763bc0547d25330a0369309fb
2020-12-16 09:23:06 -08:00
Michel Weststrate
32a75ecb58 Restructure extending docs
Summary:
This diff restructures the 'extending' section of the docs, and rebrands it to 'creating plugins'. It then restructures this section into 4 top-level items

* Tutorial
* Desktop plugin APIs
* Client plugin APIs
* Workflow

Pages are put under the relevant sections, including pages which were before under internal. Some pages that didn't relate directly to plugin development have been moved to other top level sections (e.g. testing RN).

I didn't do de-duplication between pages yet, that will be done in the next diff.

Overview of changes:

* Extending -> Creating Plugins
* Moved Extending > Other platforms to Setup > Other platforms (as this is about clients, not plugins)
* Moved Internal FB plugin development stuff into Creating Plugins
* Separated Creating Plugins into ‘Tutorial’, Desktop API Reference, Cient API Reference, Workflow
* Remove TypeScript strict page, we are already strict
* Moved QPL linters to api docs and named id QPL lints
* Grouped the different pages on extending Layout plugin (needs deduping still)
* Warning about avoiding custom styling in general
* Moved internal index page to the top of the navigation of FB Internal, rather than at the bottom

Reviewed By: passy

Differential Revision: D25585172

fbshipit-source-id: ba2aa891395097d6aa101809084b915f115ee69d
2020-12-16 05:55:23 -08:00
John Knox
063a1d191f Combine internal and external navigation plugin setup pages
Summary:
Now in public, the setup page remains unchanged, well, the headings are one level smaller.

In internal, the page is divided into two sections: for buck based apps, and non-buck based ones.

Reviewed By: mweststrate

Differential Revision: D25565953

fbshipit-source-id: abf4316a28970cd93d0cc9b56dd707f00a674a48
2020-12-16 03:30:18 -08:00
John Knox
324c54eb64 Move internal plugin pages to where the public ones are
Summary:
^

The navigation plugin also includes setup instructions which will be moved to it's own page next.
There are also now 2 navigation plugin feature pages. These still need to be consolidated.

Reviewed By: passy

Differential Revision: D25564150

fbshipit-source-id: 1fe0d853f6fa94ec62b39edacd268519fa18485a
2020-12-16 03:30:18 -08:00
John Knox
a76bdcbca2 Move iOS setup guide to getting-started section
Summary:
Putting both iOS setup guides next to each other.
I'm not sure what to call the oss one. It applies to cocoapods, swift, and pure objc.

Reviewed By: passy

Differential Revision: D25563988

fbshipit-source-id: a7ee2a0ae04e5753a74939b1c170d9a2f2ace1a9
2020-12-16 03:30:18 -08:00
John Knox
13a11f0bda Move android setup guide to getting-started section
Summary: Puts both the "Adding flipper to android apps" page next to each other, one for buck and one for gradle. The buck one is only internal.

Reviewed By: passy

Differential Revision: D25563688

fbshipit-source-id: 1937cfdd0d5129b54a8635efe6294ba39a26be8e
2020-12-16 03:30:18 -08:00
John Knox
9c8e803878 Delete duplicated extending layout plugin pages
Summary:
This content is currently duplicated in the fb internal section. So deleting it.
It's also in public here: https://www.internalfb.com/intern/staticdocs/flipper/docs/extending/layout-inspector

The only content in these files that isn't an exact dupe, is the iOS "Adding the plugin to a new app". But that's already covered in the plugin setup page: https://www.internalfb.com/intern/staticdocs/flipper/docs/setup/layout-plugin

Reviewed By: passy

Differential Revision: D25563321

fbshipit-source-id: 26d3b8c2c01c170cd440ae78bfaff20a13f90d37
2020-12-16 03:30:17 -08:00
Michel Weststrate
63e46738c1 Move GK documentation / explanation to the refguide
Summary: ^

Reviewed By: nikoant

Differential Revision: D25559029

fbshipit-source-id: cf47c3f3b9d567ba24b7a6a254a945c763350195
2020-12-15 12:34:14 -08:00
Michel Weststrate
f9c8826090 Use the same create-plugin tutorial for FB and non-FB users
Summary: Per title

Reviewed By: passy

Differential Revision: D25558871

fbshipit-source-id: 85fbc73143a5ca172115169d08f8cdce502eb833
2020-12-15 12:34:14 -08:00
Michel Weststrate
d08aa5d33e Removed void intro page to the tutorial
Summary: The 'extending flipper' introduction page didn't contain anything meaty, so collapsed it into the tutorial introduction, cleaning up the top level navigation.

Reviewed By: passy

Differential Revision: D25531718

fbshipit-source-id: ca0f98186e889e13cb97be8818db3588738e5039
2020-12-15 08:22:31 -08:00
Pascal Hartig
e188469acd Add public release docs
Summary: Per title.

Reviewed By: nikoant

Differential Revision: D25535920

fbshipit-source-id: 63fc1b7f5ea122478a3e82e3345d057bc7be37cd
2020-12-14 11:27:01 -08:00
John Knox
083dbd3dbc Merge troubleshooting pages
Summary:
This replaces the existing "FB Internals" troubleshooting" page with a redirect to the now single troubleshooting page, to make sure no links break.

It copies the content of that internal page into an internal-troubleshooting.mdx file, that isn't in any sidebars.

And it gets the main troubleshooting page to include that page, when doing an internal build. So now we only have one troubleshooting page.

Reviewed By: passy

Differential Revision: D25372552

fbshipit-source-id: 1a310ca1a4a21683d6074d480e819e5af40c8af2
2020-12-09 04:12:49 -08:00
Michel Weststrate
cc438e60ad Update public docs to use Sandy
Summary: This updates the docs of Flipper to use Sandy, rather than `FlipperPlugin` class. Restructured the docs a bit as a result.

Reviewed By: passy

Differential Revision: D24991285

fbshipit-source-id: 66d5760c25cf9cf3983515433dfd64348d51db3d
2020-11-16 13:10:32 -08:00
Michel Weststrate
29e3d80669 Moved docs outside FB Internal
Summary: Moved docs outside of FBInternal docs. Will make Sandy APIs the default in the docs soon, and move the links to the proper location, but this at least makes sure we can already link to the correct place in WP announcements

Reviewed By: jknoxville

Differential Revision: D24829287

fbshipit-source-id: 913f2db65a7cdd04bd1be47aebc48ece7a6cef04
2020-11-09 08:24:28 -08:00
Pascal Hartig
59921da02a Move release infra docs
Summary: It's a lot more than just "launcher" now.

Reviewed By: nikoant

Differential Revision: D24425780

fbshipit-source-id: 74f6dd4d73a224a43608c4d3f3698dbd16c2e865
2020-10-21 02:58:21 -07:00
Anton Nikolaev
d468d94363 Back out "Show FB internal instructions by default on "Getting Started" page"
Summary: Unfortunately optional require does not work with docusaurus bundler configuration in case file not exist, so open source build is failing now. I'm backing out this commit until solution for dynamic imports in docusaurus found.

Reviewed By: mweststrate

Differential Revision: D23679198

fbshipit-source-id: 9be008f19b5945d17ec31614a8d2cb80bad9ca2e
2020-09-14 07:34:41 -07:00
Anton Nikolaev
643a656cd9 Back out "Merge internal and external troubleshooting pages into one with optional internal-only content"
Summary: Unfortunately optional require does not work with docusaurus bundler configuration in case file not exist, so open source build is failing now. I'm backing out this commit until solution for dynamic imports in docusaurus found.

Reviewed By: mweststrate

Differential Revision: D23679147

fbshipit-source-id: 7934e0a7decf128c1914f52645adaf4617c97eea
2020-09-14 07:34:41 -07:00
Anton Nikolaev
8425db7b8b Merge internal and external troubleshooting pages into one with optional internal-only content
Summary: Merged internal and external troubleshooting pages into one with optional internal-only content

Reviewed By: mweststrate

Differential Revision: D23651656

fbshipit-source-id: 330dd4b5cb49ae403a0a3760c1e23e30e56ad190
2020-09-14 03:52:28 -07:00
Anton Nikolaev
12d7b48443 Show FB internal instructions by default on "Getting Started" page
Summary:
Show internal instructions for Flipper setup by default on "Getting Started" page. This is a follow up to https://fb.workplace.com/groups/flippersupport/permalink/955763464904312/.

I used tabs component to show both internal and external content in tabs. By default, internal content is shown, but it is possible to also switch to external.

Reviewed By: jknoxville

Differential Revision: D23649955

fbshipit-source-id: c4f956e0ee9fec69cf861d96a447f934f746dd7f
2020-09-11 09:51:30 -07:00
John Knox
142eb8f9ea Add doc markers to code
Summary: Referencing these from the wiki should be better than copy-pasting so we know they are up-to-date

Reviewed By: passy

Differential Revision: D23564251

fbshipit-source-id: ad90fcaa88c3c638212a277ce49a5faa41cd07df
2020-09-07 06:40:30 -07:00
John Knox
f33d4b3f9e Add internaldocs-fb-helpers lib
Summary:
This adds a new npm package "internaldocs-fb-helpers", and shows example usage in the flipper package.

This will stop everyone from having to inline the function definitions everywhere as is currently the case.

(It's using the old internaldocs name, to match the existing docusaurus-plugin-internaldocs-fb package - I don't think that's a big deal.)

It currently exports two methods:

* `fbContent(internalContent, publicContent)`
  * Allows you to return internal or external content based on build variant.
  * Has named args so you don't accidentally put internal stuff in the external arg.

* `isInternal(): boolean`
  * Not strictly necessary, but helps if you want to write your docs using an boolean variable rather than a switching function every time.

* `fbInternalOnly(internalContent)`
  * Convenience method for when you want internal content, or nothing.

I could have put these inside the existing docusaurus plugin, but that has docu v2 as a peer dependency, and I want these helpers to work on v1 as well, so made it a standalone package.

Reviewed By: passy

Differential Revision: D23474462

fbshipit-source-id: 22e5be6de2f3233deb298f1542a06e3575b6555a
2020-09-07 03:41:10 -07:00
Pascal Hartig
787e578a33 Document PACK download mechanism
Summary:
This is a first stab at documenting the new core distribution mechanism.
There are definitely areas I just brush over that should be expanded further,
but hopefully the release process and testing steps at the end help to clarify
some of the issues we've seen recently.

Reviewed By: mweststrate

Differential Revision: D23453713

fbshipit-source-id: 9efcfca1fbdbf5606080510c3e80bd19b49caf10
2020-09-02 06:13:47 -07:00
Michel Weststrate
8a5860cb78 API reference documentation
Summary:
Documented all exposed Sandy APIs plugin developers should know about.

Honestly didn't proof-read it myself yet, but wanted to publish this diff at least before PTO, so that the information is available to anyone interested / playing with sandy

Reviewed By: jknoxville

Differential Revision: D22976373

fbshipit-source-id: c30918201d2feeb306ca0d9a3ae1ec10bdf7e2f5
2020-08-24 04:57:02 -07:00
John Knox
baa29d0b49 Manually fix up imported pages
Summary:
I've gone through all imported pages and fixed all images and links (and anything else) that didn't get converted successfully.

Also changed the new # headings to use ##, because it works better here.

And organized the sidebar like it was on the wiki

Reviewed By: passy

Differential Revision: D23241772

fbshipit-source-id: 7eab8d7d520c5d605525d9b4ad9b12b48ca92bcc
2020-08-20 12:48:57 -07:00
John Knox
c6569470f4 Import internal pages from wiki
Summary:
This is the unadulterated output from running:
`yarn start static-docs-from-wiki --wiki_name Flipper --site_dir xplat/sonar/website`

Reviewed By: passy

Differential Revision: D23241773

fbshipit-source-id: 136e99130c77bedfb66bb31e31a7b331278857bb
2020-08-20 12:48:57 -07:00
John Knox
b1e16a3160 Move using at facebook wiki page to website
Reviewed By: passy

Differential Revision: D23029433

fbshipit-source-id: bc1559fbeed9ad6838d5793000e6bd5f594bba0b
2020-08-11 03:08:36 -07:00
Anton Nikolaev
09269ddd58 Documented plugin release workflow
Summary: See title

Reviewed By: jknoxville

Differential Revision: D22410580

fbshipit-source-id: 79cc5cf1d2a04a2edf7695bdb0e3d16b38baaae9
2020-07-07 05:39:33 -07:00
Michel Weststrate
c902a27bce Add Sandy to internal documentation
Summary:
Scaffolded some internal Sandy notes and made them only internally available.

Since most of the pipeline was already set up by jknoxville, it is unclear to me if something needs to be done to set up the auto redirect from fbflipper.com

Reviewed By: jknoxville

Differential Revision: D22233534

fbshipit-source-id: 4bdf5535f5745e7e4d335647759c6cf1b7cc73c6
2020-07-01 09:12:36 -07:00