doc: link to Sphinx Stack syntax guides#1389
Merged
Merged
Conversation
elijahgreenstein
force-pushed
the
update-contributing
branch
from
1dad68c to
a2dccb5
Compare
This commit brings the MicroCloud documentation into alignment with the LXD documentation by removing the MyST cheat sheet and instead referring contributors to Sphinx Stack guides to MyST Markdown and reStructuredText. This commit also removes a `.wokeignore` file that is no longer necessary following the removal of the cheat sheet. Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
elijahgreenstein
force-pushed
the
update-contributing
branch
from
a2dccb5 to
3df4f0a
Compare
roosterfish
approved these changes
May 26, 2026
2 tasks
roosterfish
added a commit
that referenced
this pull request
May 28, 2026
This PR backports documentation updates from commits 15e4e54 to 3df4f0a (PRs #1362 , #1364, #1368, #1371, #1374, #1382, and #1389), with two exceptions: - Commit 1c8c8f8 (from #1363) was not backported. That commit added cross references to MicroCeph reference labels that were added to the MicroCeph documentation (see canonical/microceph#719). The MicroCloud 2 documentation, however, builds older versions of the MicroCeph documentation that do not include the reference labels. (cf. the discussion in #1344). - Commit 9626a1b (from #1368) was not backported. That commit involved configuration of the Swagger UI, which is not used in MicroCloud 2. Most of the commits in this backport are from the tooling update in #1368. A few edits were made: - `doc/conf.py` was amended to remove the `html_extra_path`, which is used for Cluster Manager--specific documentation in version 3. - URLs for LXD, MicroCeph, and MicroOVN were amended to use the pinned versions (`stable-v5.21`, `v19.2.0-squid` and `24.03`, respectively). - Swagger UI related tooling was removed (specific to MicroCloud 3). - A note on snap channels was edited to refer to the LTS release, rather than the feature release. ## Checklist - [x] I have read the [contributing guidelines](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md) and attest that all commits in this PR are [signed off](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#including-a-signed-off-by-line-in-your-commits), [cryptographically signed](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#commit-signature-verification), and follow this project's [commit structure](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#commit-structure). - [x] I have checked and added or updated relevant documentation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR brings the MicroCloud documentation into alignment with the LXD documentation (canonical/lxd#18310 and canonical/lxd#18325) by removing the MyST cheat sheet and instead referring contributors to the Sphinx Stack guides to MyST Markdown and reStructuredText. This PR also removes a
.wokeignorefile that is no longer necessary following the removal of the cheat sheet.Checklist