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
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: Prevent leaking Flipper styles and antd styles into the website by embedding the styleguide into an iframe.
Reviewed By: nikoant
Differential Revision: D34522771
fbshipit-source-id: a05bf1e7f54fe172fb012a0a02296b3a4e0100f1
Summary:
allow-large-files
During decapitation the style guide was accidentally removed. In this diff we bring it back and embed it into our docs.
The only caveat is that the fonts have slightly changes because we included antd.css. It does not change too much from my point of view, but I would love to hear from the team.
Reviewed By: jknoxville
Differential Revision: D34339758
fbshipit-source-id: 10d347bc805f9314ae717de483bf8b766000280f
Summary:
Flipper docs were loading really slowly and I found in dev tools that was becuase of requests to scripts specified in docusaurus config which were not found because of relative urls used. This diff fixes that by specifying absolute URL for script loading.
{F696549860}
Reviewed By: jknoxville
Differential Revision: D33845659
fbshipit-source-id: 5079dba442f5fdf4b4f3b2a64146535b39ea72a4
Summary:
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.3 to 1.14.7.
<details>
<summary>Commits</summary>
<ul>
<li><a href="2ede36d7c6"><code>2ede36d</code></a> Release version 1.14.7 of the npm package.</li>
<li><a href="8b347cbcef"><code>8b347cb</code></a> Drop Cookie header across domains.</li>
<li><a href="6f5029ae1a"><code>6f5029a</code></a> Release version 1.14.6 of the npm package.</li>
<li><a href="af706bee57"><code>af706be</code></a> Ignore null headers.</li>
<li><a href="d01ab7a5c5"><code>d01ab7a</code></a> Release version 1.14.5 of the npm package.</li>
<li><a href="40052ea8aa"><code>40052ea</code></a> Make compatible with Node 17.</li>
<li><a href="86f7572f93"><code>86f7572</code></a> Fix: clear internal timer on request abort to avoid leakage</li>
<li><a href="2e1eaf0218"><code>2e1eaf0</code></a> Keep Authorization header on subdomain redirects.</li>
<li><a href="2ad9e82b62"><code>2ad9e82</code></a> Carry over Host header on relative redirects (<a href="https://github-redirect.dependabot.com/follow-redirects/follow-redirects/issues/172">https://github.com/facebook/flipper/issues/172</a>)</li>
<li><a href="77e2a581e1"><code>77e2a58</code></a> Release version 1.14.4 of the npm package.</li>
<li>Additional commits viewable in <a href="https://github.com/follow-redirects/follow-redirects/compare/v1.14.3...v1.14.7">compare view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `dependabot rebase` will rebase this PR
- `dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `dependabot merge` will merge this PR after your CI passes on it
- `dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `dependabot cancel merge` will cancel a previously requested merge and block automerging
- `dependabot reopen` will reopen this PR if it is closed
- `dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/facebook/flipper/network/alerts).
</details>
Pull Request resolved: https://github.com/facebook/flipper/pull/3285
Test Plan:
Imported from GitHub, without a `Test Plan:` line.
**Static Docs Preview: flipper**
|[Full Site](https://our.intern.facebook.com/intern/staticdocs/eph/D33569679/V4/flipper/)|
|**Modified Pages**|
Reviewed By: aigoncharov
Differential Revision: D33569679
Pulled By: passy
fbshipit-source-id: f31911939f66d55fc35ac46c7fe3c57fc743aab3
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:
* 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
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: Starting just with Android On Demand. iOS will follow shortly.
Reviewed By: antonk52
Differential Revision: D32724229
fbshipit-source-id: b4276aae2a7349815d691b854adcfc531b702ae7
Summary:
We generate two types of pages for plugin docs currently:
1) Full page used on Flipper docs website
2) Page without nav/header/footer which is used to embed docs into Flipper
The problem is that both of them now indexed and can both appear in search result.
See e.g. search results for keyword "android" which contains a lot of such embedded pages just because they have their first sections with name "Android" and because of that indexed to the top although shouldn't appear in search results at all.
{F683602640}
This diff disables indexing for embedded pages as it should be only possible to open them in Flipper.
Reviewed By: passy
Differential Revision: D32727589
fbshipit-source-id: 2068b8d39f19004a449098652c4c0cc2c7272d40
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
Summary: This has to be set so codehub and vscode links get the right prefix
Reviewed By: passy
Differential Revision: D32205617
fbshipit-source-id: d60dcd5bcc5a9194c22e2a27e7b9980034a6f010
Summary: Was gonna write some docs so wanted to use the opportunity to get docusaurus up-to-date.
Reviewed By: jknoxville
Differential Revision: D31956185
fbshipit-source-id: be7304ac2def5bb5576e076c1c13f79cb2b4bab3
Summary: Small bumps to get ahead of dependabot.
Reviewed By: mweststrate
Differential Revision: D31574709
fbshipit-source-id: d7e44d81277adc3a5b179ed29be19f04129b7292
Summary:
The entire repo is MIT (unless stated otherwise) but
without the flag, yarn is very noisy on every startup.
{F668266100}
Reviewed By: timur-valiev
Differential Revision: D31429016
fbshipit-source-id: 11a963181dc309a251e6c71a9a16ab93d12b7f93
