Commit Graph

19 Commits

Author SHA1 Message Date
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