Commit Graph

15 Commits

Author SHA1 Message Date
Kevin Strider
0b16f3a031 NEW troubleshooting section (SetUp)
Summary: Restyle of Trobleshooting, which involved changes to sidebar.js and splitting up the previous troubleshooting page into five separate pages.

Reviewed By: lblasa

Differential Revision: D36282539

fbshipit-source-id: e60834e2b4d98b70b23bb11309c3438d85e4de0e
2022-05-11 08:58:34 -07:00
Kevin Strider
57e3253bb0 index.mdx (SetUp - Desktop App)
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: lblasa

Differential Revision: D36244835

fbshipit-source-id: 8f19cf6bb5064da98f567e8fede2af80b8004ced
2022-05-09 10:46:47 -07:00
Michel Weststrate
7efad4201c Document how to use Node.js api's
Summary:
* Documented `npx flipper-server`
* Documented how to properly interact with the OS from Flipper plugins

Reviewed By: antonk52

Differential Revision: D33361929

fbshipit-source-id: 3028de2bf77a9ee6d9e521c1a53cff2388c936ea
2022-01-04 09:06:15 -08:00
Anton Nikolaev
ceba421997 Prepend mdx files which used as includes with underscore to avoid creating and indexing pages from them
Summary:
By default docusaurus generates pages and routes for every mdx file it finds under the root dir. So even for the mdx files which are only used as includes and don't even have headers, page is still created, then index and often looks very weird, e.g. title is the same as file name etc. See e.g. this one: https://www.internalfb.com/intern/staticdocs/flipper/docs/fb/portal-troubleshooting/

I went through Flipper docs and renamed all mdx files which are only used as includes to prepend them with underscore. Everything which name is starting with underscore, or which is inside a folder which name is starting with underscore is considered private by docusaurus and skipped.

Reviewed By: passy

Differential Revision: D32722547

fbshipit-source-id: 0524d4dd56960714fbdd2b01ad8383cd16de4948
2021-11-30 13:26:17 -08:00
Andrey Goncharov
9b16d0c29a Add documentation
Summary: Document Flipper integration with JavaScript clients.

Reviewed By: passy

Differential Revision: D31827187

fbshipit-source-id: c40d8820241c0f85bd2366a0c087d4270d316c71
2021-10-22 06:30:15 -07:00
Steven Conaway
26aef92dc5 Add brew instructions for mac (#2108)
Summary:
Thought I'd add this to the getting started, since so many people end up downloading the release directly.

## Changelog

Added `brew` instructions for mac

Pull Request resolved: https://github.com/facebook/flipper/pull/2108

Test Plan: Just docs, so no testing needed

Reviewed By: mweststrate

Differential Revision: D27398664

Pulled By: passy

fbshipit-source-id: be9cc7007e7c5dc717aad60ec0591d4ca0d100cb
2021-03-29 10:11:51 -07:00
John Knox
08b594db5c Upgrade static docs plugin
Summary:
Upgrade the static docs plugin.

You no longer need to import OssOnly and FbInternalOnly in markdown files, so removed those imports too.

Reviewed By: passy

Differential Revision: D26580059

fbshipit-source-id: 2763de2f5fbef41ec2ac7f7bdd147418badb78b6
2021-02-22 09:17:44 -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
09e3c7a80f Add chocolatey as a way to install openssl for windows (#1527)
Summary:
We've had several reports that Chocolatey-provided openssl works well with Flipper, so recommending it here.

Pull Request resolved: https://github.com/facebook/flipper/pull/1527

Reviewed By: passy

Differential Revision: D23705926

Pulled By: jknoxville

fbshipit-source-id: c582b2319caf1aa67890c1fefc66730dc1047ecd
2020-09-15 10:26:25 -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
46e9637cf2 Add openssl for windows download link
Summary: Pointed out in https://github.com/facebook/flipper/issues/1440

Reviewed By: passy

Differential Revision: D23132527

fbshipit-source-id: a1357b7c26d0b27f6eedabe2fd2dcfae647a878c
2020-08-17 02:34:43 -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