Commit Graph

24 Commits

Author SHA1 Message Date
Anton Kastritskiy
7d4a6437ef Force trailing slash for flipper website
Summary: Use docusaurus new config option to force trailing slashes for all routes and fail build when extensions are not specified in markdown links to prevent flapping urls that lead to 404 in certain situations.

Reviewed By: jknoxville

Differential Revision: D32533292

fbshipit-source-id: a2d5fdff396b3bb4319893634dd637275ea9f598
2021-11-18 09:32:30 -08:00
Pascal Hartig
781df776f2 Rename default branch references to main (#2689)
Summary:
I really hope I hit everything and didn't break anything that wasn't
referring to branch names.

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

Test Plan:
_eyes

CI

|[Site Preview: flipper](https://our.intern.facebook.com/intern/staticdocs/eph/D30305789/V2/flipper/)

Reviewed By: timur-valiev

Differential Revision: D30305789

Pulled By: passy

fbshipit-source-id: 5daaa09250bb96bb50be679fc01dae86c666eb73
2021-08-13 15:00:39 -07:00
Ananya Arun
cfc9e07fe2 Fix broken link
Summary: Fixed a broken link in the troubleshooting page of flipper.

Reviewed By: passy

Differential Revision: D29986130

fbshipit-source-id: 2e771a511afa23e4c1e11aa3817c854eff56bcab
2021-07-29 04:56:41 -07:00
Pascal Hartig
b8e67b9e04 Edit troubleshooting.mdx using inpage editor
Summary:
Just wanted to give this a try. Fixed Flipper capitalization inconsistencies.

*This diff has been automatically generated by the inpage editor*

Differential Revision: D29711275

fbshipit-source-id: 8302220b87c504b4f1ccc422aa05c1c559809cbb
2021-07-15 10:12:35 -07:00
Michel Weststrate
ab17bbd555 Allow using global devTools
Summary:
Currently Flipper embeds the React devTools, and as a result the version of the React devTools is strictly coupled to the Flipper version. This is troublesome when connecting to (slightly) older React Native versions, that use a different version of the tools. That results in errors like this one:

{F615263497}

This diff introduces a feature to use globally installed devTools instead of the embedded ones, giving users the flexibility to pick their own version.

{F615263580}

This addresses

https://fb.workplace.com/groups/flippersupport/permalink/1125669971246993/
https://github.com/facebook/flipper/issues/2250
https://github.com/facebook/flipper/issues/2224

Changelog: [React DevTools] It is now possible to switch between the embedded and globally installed version of the React DevTools. This will enable the React DevTools to connect to older RN versions. Fixes #2250, #2224

Reviewed By: passy

Differential Revision: D28382586

fbshipit-source-id: a5386a5043933acda5aab2db74078bf7ceb105ca
2021-05-12 14:21:53 -07:00
Michel Weststrate
9e978cad76 Bump react-devtools-core upward for compatibility
Reviewed By: passy

Differential Revision: D27850934

fbshipit-source-id: 0b03b110accce7aa522f3e18edba8c316f9d00d8
2021-05-07 09:04:03 -07:00
Michel Weststrate
d13d8edf23 Documented how to connect to physical iOS device
Summary: Updated outdated docs are reported in https://github.com/facebook/flipper/issues/1250

Reviewed By: priteshrnandgaonkar

Differential Revision: D27361276

fbshipit-source-id: 87bede49501d6ae7d2a9612b769e1e1c1d7803b1
2021-03-29 07:00:47 -07:00
Bartosz Kaszubowski
40e6cdebb1 improve docs code blocks highlighting (#2049)
Summary:
This PR adds missing Objective-C entry to the Docusaurus config, fixes Objective-C code blocks label and adds or replaces several code block labels to improve the currently highlighted blocks.

Prism in Docusaurus by default also includes syntax highlight for `jsx` and `tsx`, which improves the nodes and props highlight, so I have used those syntaxes in few places too.

I have also fixed one typo that I have spotted and my IDE made a cleanup of whitespaces in edited files.

## Changelog

* [website] improve docs code blocks highlighting

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

Test Plan:
The changes have been tested running Flipper website on `localhost`.

## Preview

<img width="650" alt="Screenshot 2021-03-12 150934" src="https://user-images.githubusercontent.com/719641/110951135-fff20d00-8344-11eb-96db-1bdc82c8d5ea.png">

<img width="649" alt="Screenshot 2021-03-12 151022" src="https://user-images.githubusercontent.com/719641/110951268-2ca62480-8345-11eb-9d3b-1a48f1267776.png">

Reviewed By: priteshrnandgaonkar

Differential Revision: D27336599

Pulled By: passy

fbshipit-source-id: c2dfb3d8cad4675da0f5e1270cada1e56a0175c0
2021-03-29 02:46:11 -07:00
John Knox
11879c127b Add portal troubleshooting instructions
Summary: Adds an internal section for portal troubleshooting

Reviewed By: passy

Differential Revision: D26847795

fbshipit-source-id: b12bef20b2f832c4264cfd5cafcced414575b82b
2021-03-05 10:32:35 -08:00
Pascal Hartig
a4e457306c Add note about duplicate FBJNI classes
Summary:
Not sure if I made this clearer or even more confusing,
but it's a try.

Reviewed By: mweststrate

Differential Revision: D26781610

fbshipit-source-id: d68b30ffe6b24d537473c2d85b2b74f425068a96
2021-03-03 10:33:01 -08:00
Michel Weststrate
4799ea4f09 Documented how to opt out from flipper on iOS
Summary: More docs. Addresses https://github.com/facebook/flipper/issues/1326, https://github.com/facebook/flipper/issues/1215 and probably more

Reviewed By: jknoxville

Differential Revision: D26778514

fbshipit-source-id: dcadbad8f53f483d14e7fc54199756a697095309
2021-03-03 07:23:12 -08:00
Michel Weststrate
effd334f98 Improve iOS troubleshooting guide
Summary: Added some pointers for everyone who is as iOS noobish as me.

Reviewed By: priteshrnandgaonkar

Differential Revision: D26777687

fbshipit-source-id: 1ba3bb08b5a7b3a3ba937176d4c4c9b5e765a977
2021-03-03 05:05:05 -08: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
Michel Weststrate
727c99b729 Introduce support for no hardware acceleration
Summary: Start flipper with `--no-launcher --disable-gpu` to disable hardware acceleration

Reviewed By: passy

Differential Revision: D25994355

fbshipit-source-id: e75bb209c8e3325135a114bec1f25889187d2728
2021-01-22 05:31:00 -08:00
Michel Weststrate
ddd9536e14 Add more explicit notes on how to update the Flipper SDK in react-native
Summary: Per title

Reviewed By: passy

Differential Revision: D25756219

fbshipit-source-id: c1620cc7dda0195965a697a75db836b2057be3e9
2021-01-04 12:17:56 -08:00
John Knox
00356f96c5 Convert Link tags to md syntax
Summary:
Previously we used <Link/> everywhere with useBaseUrl to avoid link destinations depending on the current url of the page.

This isn't necessary if you instead link to the **file name**, rather than the **url path**.
Then the links are resolved at build time, and work across imported markdown files etc.

This diff just does the pages under Features, because other ones will get conflicts. I'll do those later.

Reviewed By: nikoant

Differential Revision: D25589707

fbshipit-source-id: 35ca986e19fc2af1054b81d7253eeb3827947ab8
2020-12-16 10:37:34 -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
0f9e97e55c Add troubleshooting guide for yoga module errors
Summary: Tried to sum up all solutions mentioned in https://github.com/facebook/react-native/issues/28503 for this recurring problem. The most common problem being simply opening the wrong file in XCode. From experience I can tell this is not obvious for iOS noobs like me :-P.

Reviewed By: passy

Differential Revision: D24359426

fbshipit-source-id: bb4d4951ac287ed2b09203e5414f62628a3feeb0
2020-10-16 04:10:33 -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
John Knox
40a5721d45 Fix link to diagnostic screen setup
Summary: Was pointed out to be broken in https://github.com/facebook/flipper/issues/1254

Reviewed By: mweststrate

Differential Revision: D22117270

fbshipit-source-id: 15947f9e0373b4324165de7d1a2a6be70a8e652c
2020-06-19 07:58:50 -07:00
Michel Weststrate
04e58cd6c2 Extended trouble shooting for React Native
Summary: We get a lot of requests related to things not working on RN. The questions and solutions are often quite similar, so wrote down all the answers I know from the top of my head. From now on we can link to this guide, and extend it were needed with better answers

Reviewed By: passy

Differential Revision: D22042296

fbshipit-source-id: ba8a71f3ef6f241aaa1d2883d1348c0471a38e3b
2020-06-15 07:10:50 -07:00
John Knox
281cd67ddb Fix some broken links
Summary:
KESHAmambo pointed out some internal links are broken on the website: https://twitter.com/KESHAmambo/status/1255443093542895619

The way relative links are processed in docusaurus v1 and v2 has changed. This fixes them up.

Reviewed By: mweststrate

Differential Revision: D21301293

fbshipit-source-id: 7610e38a55bc066625373cf2eee9a3efb63aec08
2020-04-29 05:21:31 -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