Summary:
^
Currently, it is a duplicate of the ui-debugger documentation image. The idea is creating this asset, for which we can obtain a URL, which can then be freely updated as we see fit.
Reviewed By: passy
Differential Revision: D49770514
fbshipit-source-id: 77a891c92e6aa803ad08a9b909ffd23d6a61c5a0
Summary: These resolutions aren't used, validated with `yarn why`. See the diff higher in the stack for automation.
Reviewed By: yungsters
Differential Revision: D47282205
fbshipit-source-id: a2e909e3802f780fbe7525e5945faebee7004aef
Summary:
There's a picture with a broken link in the hero section:
{F999641292}
I checked a list of existing static images and found one which was on this place before: https://fburl.com/code/yh73399d. But the image no longer align with others, since it has low resolution and an old version of the Flipper interface, so I decided to simply remove the broken image from the page.
Reviewed By: passy
Differential Revision: D46074714
fbshipit-source-id: 186b17b9b992f123fc667c701b4f49d9e3cbbb2d
Summary:
Hoping that this will fix our docs build.
Note that I also had to fix a syntax error in `extending/loading-custom-plugins.mdx` that
broke the build with:
```
SyntaxError: /Users/realpassy/fbsource/xplat/sonar/docs/extending/loading-custom-plugins.mdx: Expected corresponding JSX closing tag for <admonition>. (10:10)
8 | <FbInternalOnly>
9 | <admonition {...{"type":"caution"}}><p parentName="admonition">{`Within Meta, plugins sources are stored and loaded from `}<inlineCode parentName="p">{`~/fbsource/xplat/sonar/desktop/plugins`}</inlineCode>{`, in which case no further configuration is needed.`}</p><p parentName="admonition">{`If your team uses Flipper plugins that are stored outside `}<inlineCode parentName="p">{`fbsource`}</inlineCode>{`, please follow your team specific instructions.
> 10 | ::::`}</p></FbInternalOnly><p parentName="admonition">{`Flipper loads and runs plugins it finds in a configurable location. The paths searched are specified in `}<inlineCode parentName="p">{`~/.flipper/config.json`}</inlineCode>{`. These `}<inlineCode parentName="p">{`pluginPaths`}</inlineCode>{` should contain one folder for each of the plugins it stores.`}</p><p parentName="admonition">{`An example config setting and plugin file structure is shown below:`}</p><p parentName="admonition"><inlineCode parentName="p">{`~/.flipper/config.json`}</inlineCode>{`:`}</p><pre parentName="admonition"><code parentName="pre" {...{"className":"language-bash"}}>{`{
| ^
11 | ...,
12 | "pluginPaths": ["~/flipper-plugins"]
13 | }
client (webpack 5.74.0) compiled with 1 error
```
Reviewed By: ivanmisuno
Differential Revision: D43767006
fbshipit-source-id: 64288d63c305bc9a9c9b797110889a703c7dcfee
Summary:
The website generation fails on newer versions of `flipper-plugin` as it contains an import-time side effect. This leads to this error during build time:
```
[ERROR] Docusaurus server-side rendering could not render static page with path /docs/extending/style-guide/.
[INFO] It looks like you are using code that should run on the client-side only.
To get around it, try using `<BrowserOnly>` (https://docusaurus.io/docs/docusaurus-core/#browseronly) or `ExecutionEnvironment` (https://docusaurus.io/doc
s/docusaurus-core/#executionenvironment).
It might also require to wrap your client code in `useEffect` hook and/or import a third-party library dynamically (if any).
```
This ain't pretty but by wrapping the entire file in a single function that conditionally imports the `flipper-plugin` if we are indeed in a browser environment fixes the problem.
Reviewed By: antonk52
Differential Revision: D43773298
fbshipit-source-id: 8e1099249626ca9fe745ce51014491fe9674a5a4
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:
The site loads the style guide in an iframe so that it's css is isolated from the main sites styles.
But it doesn't know how big to render the iframe, because it doesn't know the size of its contents.
Previously, the js running inside the iframe measured itself and then accessed itself using the parents frame and modified it's own size to match.
That doesn't work anymore because the iframe isn't allowed to interact directly with its parent.
So instead, i'm using message passing.
Also changing MutationObserver to ResizeObserver because the former does not always fire when new css gets loaded and applied.
Reviewed By: aigoncharov
Differential Revision: D41735809
fbshipit-source-id: 9e84a9b20741f5470012e25f240fb6a2b494f7e3
Summary:
This diff includes minor changes to the pages within the Under the Hood section of Flipper Docs.
The page Creating Plugins -> Desktop Plugin APIs -> QPL Linting -> Building a Linter is now removed from the sidebar.
Reviewed By: lblasa
Differential Revision: D41533283
fbshipit-source-id: 63e50210815fe2b67ea54991eb8a7bc16e04e1be
Summary: This diff includes minor changes to the pages within the Under the Hood section of Flipper Docs.
Reviewed By: passy
Differential Revision: D41521538
fbshipit-source-id: 35b372ffdde118faef2732e4cb7684fc9df18f87
Summary: Wanted to write about this for a while as we're reinventing the rules every time we get to this time of the year. :)
Reviewed By: LukeDefeo, antonk52
Differential Revision: D41434886
fbshipit-source-id: 445c6c259bee74874472cf246fdc209e82514fcd
Summary: Pretty much copy/paste from Pascal's post on data pipelines as it provides a quick overview of things involved
Reviewed By: passy
Differential Revision: D41274753
fbshipit-source-id: 337b034d2460ba448582b9dea70b835898627faa
Summary: This change alphabetically sorts the 'Under the Hood' section and adds a 'Meta' parent category for everything that is internal as to add a visual cue of what is internal and whats not.
Reviewed By: passy
Differential Revision: D41273678
fbshipit-source-id: 1acf8da184762d5924bff90b6691be1e4be92c46
Summary: Doing this to get better logging in case we get transient failures again when fetching code snippets
Reviewed By: antonk52
Differential Revision: D41118788
fbshipit-source-id: f6cb9e20a08920f5935b14d765ac4c053ac5c78f
Summary: This is required to enable off-VPN access to the site
Reviewed By: antonk52
Differential Revision: D37611617
fbshipit-source-id: 7599fc22766315d799345e955fc87ff3a7ddf50f
Summary: Wanted to write down the not-obvious release procedure somewhere. We can extend this with some troubleshooting procedures.
Differential Revision: D37463848
fbshipit-source-id: 899cdfd12fdb0647579271d883f499872167743f
Summary:
This is a new section under 'Contributing to the Documentation', in the 'Under the Hood' menu.
It includes two new pages:
* Documentation Formatting Tips (created here. For content, see D37006489)
* Writing Guide (created here. For content, see D37006980)
Setup in sidebar.js.
Reviewed By: lblasa
Differential Revision: D37004092
fbshipit-source-id: 5fa0a38632f7fa9d9178b69a89d9b21f5bda39ab
Summary:
Kevin Strider after reviewing Flipper docs structure suggested to show all sections in sidebar. This will make it easier for users to navigate website as they will be able to find all the content through sidebar menu.
Before that only current section items were shown, so e.g. if user clicks "Learn more" on the start page they open "Features" section and it's not clear that there are a lot of other content (Setup, Creating Plugins, Under the Hood) which is only available through the top menu.
Reviewed By: antonk52
Differential Revision: D36762008
fbshipit-source-id: a36cfb77e5d2efd4f5d8795d1c68e46d07ed79e1
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: Troubleshooting docs structure refactored. This should fix publishing of docs on GitHub which is currently failing, because of link to fb-only page from public page: https://github.com/facebook/flipper/actions/runs/2351680003.
Reviewed By: passy
Differential Revision: D36513180
fbshipit-source-id: c0339d437f560464e771e46dfc0a55782faf6a54
Summary:
Major changes to js-custom.mdx
The content for the following pages is moved to the new sub-folder 'Building a Desktop Plugin':
* js-custom.mdx
* js-setup.mdx
* js-table.mdx
The Title and Sidebar labels have been changed accordingly.
Changes made to sidebar.js,
Reviewed By: lblasa
Differential Revision: D36415874
fbshipit-source-id: 8f1634abc1459d1905da62a1b76bac4b621d0da5
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
