Summary: Moved plugin documentation and related assets to plugin folders, fixed links and configured redirects where required. Now these docs are used for both showing docs in Flipper and generating Flipper docs website.
Reviewed By: passy
Differential Revision: D29465567
fbshipit-source-id: 3ec4240b215b0d5baea5154f64266a9ba7ead3a5
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:
Noticed this when building the site. Shame it only warns and doesn't fail the build.
Just fixing it while I'm here.
{F479009268}
Reviewed By: nikoant
Differential Revision: D26911725
fbshipit-source-id: 6440a4b8aee4a6bc053ae771a3b148fd70ffc298
Summary:
The redirects we added inline in the deleted pages don't work when there's a baseUrl.
This is because it's the standard react-router Redirect component, which knows nothing about docusaurus sites.
We could get around that by adding `useBaseUrl()` calls around all of them, but that's not great.
So changing to using declarative redirects instead, where they are all put in config. This automatically takes care of base urls, and reduces copy-pasted code.
Reviewed By: passy
Differential Revision: D25780599
fbshipit-source-id: c67d3643ab28f0fcd440904baf54c67687781686
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
Summary: Translated all cases where we had a parent-relative link to use the base URL instead.
Reviewed By: jknoxville
Differential Revision: D22256229
fbshipit-source-id: 81ee6fecb77dbaa19d112cb319771c22ff66d02a
Summary:
Somehow I missed these two the last time.
These are the final broken links reported by https://www.brokenlinkcheck.com/broken-links.php#status except for the "edit this page" link on the autogenerated ui-components page.
Reviewed By: mweststrate
Differential Revision: D21325511
fbshipit-source-id: dbc61bbed1366a007ed2cdde3a72f8ea974d871f
Summary:
Used https://www.brokenlinkcheck.com/broken-links.php#status for now to find broken links and fixed them all.
Would be better to use some automated tool to check this at diff time, but that's not setup yet.
Reviewed By: passy
Differential Revision: D21301702
fbshipit-source-id: f13c8769b15d9f99563fc65dc0544320d07a2bfb
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
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:
We've ported [Reactotron](https://infinite.red/reactotron) to work as a Flipper plugin. This adds a new section listing known community plugins and starts with Reactotron-in-Flipper as an example.
## Changelog
Added one section to the React Native page.
Pull Request resolved: https://github.com/facebook/flipper/pull/1009
Test Plan: Docs-only.
Reviewed By: passy
Differential Revision: D21039079
Pulled By: mweststrate
fbshipit-source-id: 1187119d78baba321012f8ffa243685b25441e9d
Summary:
When using baseUrl in site config, it adds a prefix to all link paths.
But for assets, it doesn't work if you refer to them as `docs/assets/...`, you have to use just `assets/...`. Source: https://github.com/facebook/Docusaurus/issues/861
Reviewed By: passy
Differential Revision: D20796933
fbshipit-source-id: 2346e42b8b548f576a1e143f56ee5236eab55073
Summary: Added some UI so that we can manually verify that logging and network inspection is working in RN + Flipper.
Reviewed By: jknoxville
Differential Revision: D20668428
fbshipit-source-id: 4271595583e055b2b0324b3da7ac216c39717093
Summary:
Added docs for the Navigation Plugin.
I've added instructions on how to use the plugin with vanilla Android, or how to integrate it with a third party solution.
Reviewed By: danielbuechele
Differential Revision: D16856614
fbshipit-source-id: e99cb94318820bd926f50bd4ba205fb11396a9d8
Summary:
Now that we finally have something we can screenshot ...
Just for the features page right now, will add some
"installation" instructions next.
Reviewed By: oprisnik
Differential Revision: D15898050
fbshipit-source-id: 9dfd3b1121799e7069336aac845ba2abdb3e42df
Summary:
It looked like the "..." was meant as a placeholder?
Pull Request resolved: https://github.com/facebook/flipper/pull/446
Reviewed By: danielbuechele
Differential Revision: D15337644
Pulled By: passy
fbshipit-source-id: 89d4d15d1448d8c61997341b5bfd67f2adb6a021
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
