Summary:
Provide a documentation about marketplace feature of Flipper.
This should cover:
1. Introduction of the feature (plugin discovery, auto update)2.
2. Marketplace server - to list available plugins
3. Flipper settings - describe the new settings and how to enable4.
Closes https://github.com/facebook/flipper/issues/3545.
## Changelog
Pull Request resolved: https://github.com/facebook/flipper/pull/4395
Reviewed By: antonk52
Differential Revision: D42918936
Pulled By: passy
fbshipit-source-id: 50b10178b569ecc6ea65b736ea58db401cf686c6
Summary:
LukeDefeo called out that there's currently no guide for how to create changelog items.
I couldn't find another good page to add this to. Might be a good idea to expand this with further tips for making good contributions.
Reviewed By: LukeDefeo, nikoant
Differential Revision: D36702634
fbshipit-source-id: 15bc1dcf420ea923a714929eff8ac817efa56ceb
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).
This diff includes a new version of the images:
bg-plugin-lifecycle.png
regular-plugin-lifecycle.png
The old versions have been renamed to:
bg-plugin-lifecycle.bak
regular-plugin-lifecycle.bak
Reviewed By: aigoncharov
Differential Revision: D36630758
fbshipit-source-id: 29922750364e1dd6f959bd297e3b5d5e6cf1a9ac
Summary:
Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).
This diff includes a new version of the image 'flipper-communication-diagram.png'.
The old version has been renamed to 'flipper-communication-diagram.bak'
Reviewed By: aigoncharov
Differential Revision: D36628993
fbshipit-source-id: cb59785777926b4fb8b8bb3be2aa2439d3a580d0
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).
Reviewed By: passy
Differential Revision: D35898254
fbshipit-source-id: 67e3f3e344faf105f5a8f393c60441d6af3d62aa
Summary: Document how device identifiers are obtained and used to map apps and their running device.
Reviewed By: passy, aigoncharov
Differential Revision: D33431864
fbshipit-source-id: eff4475b3b5e796b58c04db872e814f3e7d5d79e
Summary: I noticed an error on loading "google-anaytics" script, "code-blocks-buttons" script and "network.png" screenshot (which is supposed to be a part of carousel on the main page) in dev console when Flipper docs website is opened. This diff fixes them. Looks like it positively affects load speed as well because each of these failed requests takes 1-2 seconds to resolve before the failure status returned.
Reviewed By: mweststrate
Differential Revision: D33313293
fbshipit-source-id: a1f6357d89121eefa2df9aeae783cd48bc3beaf5
Summary:
This diff changes the way on how plugin documentation is produced. Instead of keeping plugin documentation together with other docs, we will now keep it together with plugin code. There are multiple advantages of such solution:
1. We are generating docs for every plugin in a standartised way so all of them looks similar. We can also use plugin metadata for generation as well (e.g. take title, icon, oncall name etc from package.json).
2. Standartised plugin docs make it possible to build docs both for websites (public and internal) and for embedding into Flipper.
3. It will hopefully incentivise authors to write docs as they will be a part of plugin "package".
4. We can scaffold documentation template using scarf to further incentivise filling it.
Reviewed By: jknoxville
Differential Revision: D29378053
fbshipit-source-id: 66ea48dc9ba225fabfb256ae6a10f8c81eef6f5f
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
Summary: This diff adds documentation and matrix explaining the supported iOS builds. It also tells about the way to enable www cert exchange.
Reviewed By: mweststrate
Differential Revision: D27676056
fbshipit-source-id: 5c8b1d0e73dd95c3ebc534fb0df7505151a6e6be
Summary:
This small PR aims to tweak a bit website appearance and fix small UI issue:
* footer background has been changed to reversed splash gradient
<img width="1104" alt="Screenshot 2021-03-04 131823" src="https://user-images.githubusercontent.com/719641/109964907-8cba1c80-7cee-11eb-8905-2fa82533cfd7.png">
* GitHub link in the Navbar has been moved to the tight and text was replaced with icon (like on few other Docusaurus sites)
<img width="557" alt="Screenshot 2021-03-04 133112" src="https://user-images.githubusercontent.com/719641/109965233-f9351b80-7cee-11eb-84d6-30788f662fbf.png">
* Navbar brand title ("Flipper") hover color issues has been fixed, now hover effect is the same as other navbar links
## Changelog
N/A
Pull Request resolved: https://github.com/facebook/flipper/pull/1998
Test Plan: Flipper website run on `localhost`.
Reviewed By: mweststrate
Differential Revision: D26888499
Pulled By: passy
fbshipit-source-id: e8abeace8c1d6ae8dcc46c2381009c2bd2500005
Summary: As reported a few times in the internal chat
Reviewed By: passy
Differential Revision: D26813161
fbshipit-source-id: 8b834c7807a7634f23c3ab922bb43e288ea4bd68
Summary:
Based on the issue here https://github.com/facebook/flipper/issues/967, I'm adding the flipper diagram to a documentation.
It should help explain briefly how does all parts communicate together and visualise key terms.
## Changelog
- Add Flipper architecture diagram to documentation
Pull Request resolved: https://github.com/facebook/flipper/pull/1073
Reviewed By: jknoxville
Differential Revision: D21278322
Pulled By: passy
fbshipit-source-id: 3cd8c71b2595b86911f5c9061bc2e8119da1d315
Summary: Changes the link color to something that isn't very similar to the rest of the text.
Reviewed By: nikoant
Differential Revision: D21328856
fbshipit-source-id: 9467e368411caeb58e00642b48ef4413d285850e
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
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
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
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
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
Summary: priteshrnandgaonkar pointed out that they sometimes overlap with the text.
Reviewed By: jknoxville
Differential Revision: D15182356
fbshipit-source-id: def39676d5dcce85aa0b41760cec0ec5cfb9398c
Summary: Adding a small ruler between each section on the landing page.
Reviewed By: jknoxville
Differential Revision: D15148067
fbshipit-source-id: 604f443c06eef16570dcdfbb21e121962b325127
Summary: Adding a "features" page to the to bar and splitting plugin descriptions from their setup instructions.
Reviewed By: jknoxville
Differential Revision: D15147464
fbshipit-source-id: b2106d825454c3b2989eb1e536b128ef9b6d0247
Summary:
All bumps are within range, so this shouldn't introduce any breaking
changes.
Pull Request resolved: https://github.com/facebook/flipper/pull/419
Reviewed By: danielbuechele
Differential Revision: D15120854
Pulled By: passy
fbshipit-source-id: dee4b52947cb548d13cd4bf625b29e3a643d8fc3
Summary:
Using `react-docgen` to automatically generate docs for our UI components.
React-docgen parses the files in `components/ui` and using comments and flowtypes to generate structured information about the UI components.
For higher-order-components `react-docgen` is not able to get the information. As we are using HOC often as part of emotion's styled-components, I added a custom parser for HOCs. Using babel/parser I am parsing the components and using their doc-comments to generate the structured description.
Then, the description generated by react-docgen and my custom parser is used to generate markdown which is added to the `ui-components.md` file of our docs.
Plus: Added some styling around the documentation of props, mostly table styles.
Reviewed By: jknoxville
Differential Revision: D12896110
fbshipit-source-id: 1337c924c06e10a5d3aa752579428fd2cc7b4743
Summary:
It's easier to find when they're in the repo. Exported them
from the AI template.
Reviewed By: priteshrnandgaonkar
Differential Revision: D9789825
fbshipit-source-id: ca717d130495842dcab4d06e02986d3df598dbe6
Summary: Fix a small issue we had with our mascot.
Reviewed By: danielbuechele
Differential Revision: D9180345
fbshipit-source-id: de1c34768b4f75202d78bd4404798a7549aa0457
