search

canonical / microcloud

Automated private cloud based on LXD, Ceph and OVN
https://microcloud.is
GNU Affero General Public License v3.0
260 stars 36 forks source link

doc: convert to Markdown/MyST #333

Closed ru-fu closed 3 days ago

ru-fu commented 1 week ago

To be consistent with LXD documentation, move our docs to Markdown instead of RST.

ru-fu commented 1 week ago

The link check is expected to fail (because the MyST cheat sheet isn't on main yet).

roosterfish commented 4 days ago

Merging it blocked (at least for me) until all the required checks pass. Can we maybe merge something beforehand to let the test succeed?

ru-fu commented 4 days ago

Merging it blocked (at least for me) until all the required checks pass. Can we maybe merge something beforehand to let the test succeed?

Sure, I can open a PR to add only the MyST cheat sheet.

Update: https://github.com/canonical/microcloud/pull/337

roosterfish commented 4 days ago

Sure, I can open a PR to add only the MyST cheat sheet.

Can be rebased now, I have just merged #337.

ru-fu commented 4 days ago

Another attempt ...: https://github.com/canonical/microcloud/pull/339

roosterfish commented 4 days ago

Another attempt ...: #339

Merged!

roosterfish commented 4 days ago

Mhh, the link checker tries to access documentation.ubuntu.com/microcloud. Shouldn't this be canonical-microcloud.readthedocs-hosted.com? I see the file is available here https://canonical-microcloud.readthedocs-hosted.com/en/latest/doc-cheat-sheet-myst/