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:
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: Not allowed within an iframe.
Reviewed By: jknoxville
Differential Revision: D26779338
fbshipit-source-id: e201002cb705ca890d6a8fa8470a391e71d8d46c
Summary:
I found a `CFBundleURLTypes` in the .app. Turns out that Munki has
a bunch of hard-to-discover deeplinks: https://github.com/munki/munki/wiki/Munki-Links
Reviewed By: mweststrate
Differential Revision: D26125684
fbshipit-source-id: 3a470360e3df287bd9a07d2e587094cbf7879e33
Summary: Also removed a weird href on a paragraph.
Reviewed By: mweststrate
Differential Revision: D26125630
fbshipit-source-id: b3fab87cf295f8fdbfe142e8c0a32909ce828a57
Summary: Makes it a bit more obvious where this link goes.
Reviewed By: passy
Differential Revision: D25639460
fbshipit-source-id: d2eed6bf2bcb0ac3b6cb9de148e62e65ab61266a
Summary:
Updated the release ent diagram using mermaid lib added in the previous diff.
nocommit until "docusaurus-plugin-internaldocs-fb" re-pointed back to npm in package.json.
Reviewed By: jknoxville
Differential Revision: D25594333
fbshipit-source-id: fd0b961c5265b8284d3c2e56e17b56fc38cc72c5
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: D23679198
fbshipit-source-id: 9be008f19b5945d17ec31614a8d2cb80bad9ca2e
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
Summary:
Show internal instructions for Flipper setup by default on "Getting Started" page. This is a follow up to https://fb.workplace.com/groups/flippersupport/permalink/955763464904312/.
I used tabs component to show both internal and external content in tabs. By default, internal content is shown, but it is possible to also switch to external.
Reviewed By: jknoxville
Differential Revision: D23649955
fbshipit-source-id: c4f956e0ee9fec69cf861d96a447f934f746dd7f
Summary:
This adds a new npm package "internaldocs-fb-helpers", and shows example usage in the flipper package.
This will stop everyone from having to inline the function definitions everywhere as is currently the case.
(It's using the old internaldocs name, to match the existing docusaurus-plugin-internaldocs-fb package - I don't think that's a big deal.)
It currently exports two methods:
* `fbContent(internalContent, publicContent)`
* Allows you to return internal or external content based on build variant.
* Has named args so you don't accidentally put internal stuff in the external arg.
* `isInternal(): boolean`
* Not strictly necessary, but helps if you want to write your docs using an boolean variable rather than a switching function every time.
* `fbInternalOnly(internalContent)`
* Convenience method for when you want internal content, or nothing.
I could have put these inside the existing docusaurus plugin, but that has docu v2 as a peer dependency, and I want these helpers to work on v1 as well, so made it a standalone package.
Reviewed By: passy
Differential Revision: D23474462
fbshipit-source-id: 22e5be6de2f3233deb298f1542a06e3575b6555a
Summary:
It's currently a lower-case "index" which looks a bit off. :)
{F235813923}
Reviewed By: mweststrate
Differential Revision: D21324972
fbshipit-source-id: 6b75b23aa0122e2db08f7532205b6e07758155fc
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:
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
