docs: sync api docs github

[taddes]

Description

Migrates old docs published to https://mozilla-services.readthedocs.io/en/latest/index.html. Converts from .rst to .md and used mdbook. Fixes broken graphviz diagrams and converts to mermaid. Publishes to our GitHub Pages.

I have done my best to mark outdated docs that we can consider sunsetting, or marking deprecated. Regardless, some of those are maintained here for legacy. Some things will need updating that I have noted and we'll take care of in other issues.

Testing

Preview docs using make doc-watch. Once merged, will publish

Issue(s)

Closes STOR-378.

[chenba]

Thanks @taddes. I was able to preview the docs locally. From clicking around I found that

• all the Syncstorage api pages 404 (and there's a typo in the title with "Styncstorage")
• some rendering/formatting issue with the Setup section of the MdBook Notes page

[taddes]

Thanks @taddes. I was able to preview the docs locally. From clicking around I found that

* all the Syncstorage api pages 404 (and there's a typo in the title with "Styncstorage")

* some rendering/formatting issue with the Setup section of the MdBook Notes page

Thanks @chenba ! I forgot to remove syncstorage/ from the internal links at the API doc index, thanks for catching that. They shouldn't 404 now. Fixed the instructions in the setup section too 👍

[chenba]

Suggested change

	# Styncstorage API
	# Syncstorage API

[taddes]

I propose an ADR where we consider renaming the service to Styncstorage 😆

[taddes]

Fixed

[pjenvey]

👃 🤢

[chenba]

I know it's not from a change on this PR but the Batches Table in syncstorage-postgres-db.md is borked.

[taddes]

I know it's not from a change on this PR but the Batches Table in syncstorage-postgres-db.md is borked.

Good catch. Fixed the bork

[chenba]

We probably don't need this anymore?

[taddes]

Yeah, I've got it on the books as something to potentially cull. Thx

[chenba]

📖