Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: convert to Markdown/MyST #333

Merged
merged 7 commits into from
Jul 5, 2024
Merged

Conversation

ru-fu
Copy link
Contributor

@ru-fu ru-fu commented Jun 26, 2024

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

@ru-fu
Copy link
Contributor Author

ru-fu commented Jun 26, 2024

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

roosterfish
roosterfish previously approved these changes Jul 4, 2024
Copy link
Contributor

@roosterfish roosterfish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looking great.

@@ -58,7 +58,7 @@ This is just the beginning of MicroCloud. We’re very excited about what’s co

### **RESOURCES:**

- Introduction: https://discuss.linuxcontainers.org/t/introducing-microcloud/15871
- Documentation: https://canonical-microcloud.readthedocs-hosted.com/en/latest/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker just wondering why we don't serve this under e.g. documentation.ubuntu.com/microcloud?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be great, but needs approval from @evildmp.

@roosterfish
Copy link
Contributor

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
Copy link
Contributor Author

ru-fu commented Jul 4, 2024

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: #337

@roosterfish
Copy link
Contributor

roosterfish commented Jul 4, 2024

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

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

@ru-fu
Copy link
Contributor Author

ru-fu commented Jul 4, 2024

Another attempt ...: #339

@roosterfish
Copy link
Contributor

Another attempt ...: #339

Merged!

No changes apart from renaming.

Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
@roosterfish
Copy link
Contributor

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/

ru-fu added 6 commits July 4, 2024 17:07
Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Get the latest changes from the starter pack.

Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Make sure woke runs on the Markdown files and fix findings.

Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Copy link
Contributor

@roosterfish roosterfish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@roosterfish roosterfish merged commit 6a443ab into canonical:main Jul 5, 2024
14 of 15 checks passed
@ru-fu ru-fu deleted the LXD-1178-markdown branch July 5, 2024 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants