Skip to content

doc: update snaps and releases documentation - #829

Merged
roosterfish merged 6 commits into
canonical:mainfrom
minaelee:releases-snap
Jun 30, 2025
Merged

doc: update snaps and releases documentation#829
roosterfish merged 6 commits into
canonical:mainfrom
minaelee:releases-snap

Conversation

@minaelee

Copy link
Copy Markdown

This PR:

  • Adds a new Releases and snaps reference page, similar to the recently added LXD documentation Releases and snap page. Updates/adds links to this page from other pages.
  • Enables use of a sustitutions.yaml file similar to LXD's for facilitating documentation updates of the current LTS and feature tracks for MicroCloud.
  • Moves the information about holding and synchronizing updates from the Manage the snap page to the Updates and upgrades page.
  • Improves and adds to the Manage the snap and Updates and upgrades how-to guides.
  • Updates the How to get support guide to align with LXD's how to get support guide.
  • Updates the How to install MicroCloud guide to use the recommended defaults for installation, indicate that specifying a channel is optional, clarify how to handle a previously installed snap, etc.

@github-actions github-actions Bot added the Documentation Documentation needs updating label Jun 23, 2025
@minaelee
minaelee force-pushed the releases-snap branch 4 times, most recently from 34b4840 to fc818dc Compare June 23, 2025 08:25
@minaelee
minaelee marked this pull request as ready for review June 23, 2025 08:30

@roosterfish roosterfish left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this, left a few comments to highlight the differences between LXD and MicroCloud releases and some more smaller details that might be helpful too.

Comment thread doc/Makefile Outdated
cd integration/microceph/docs/ && $(MAKE) html BUILDDIR=$(current_dir)/_build/microceph
cd integration/microovn/docs/ && $(MAKE) html BUILDDIR=$(current_dir)/_build/microovn
$(MAKE) -f Makefile.sp sp-html BUILDDIR=$(current_dir)/_build/microcloud
$(MAKE) -f Makefile.sp sp-html BUILDDIR=$(current_dir)/_build/microcloud ADDPREREQS='gitpython pyyaml'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I am trying to follow what this change is all about as it doesn't match the commit message.

Can you please move this change (and probably the other ADDPREREQS) into a separate commit?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah now I see, you require the pyyaml to load the substitutions file. Can you maybe add a comment somewhere?

For what is gitpython used?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Moved into a separate commit without gitpython but can't confirm that it will work without until after #839 is merged (per tests currently failing due to MicroCeph changes).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PR can be rebased now, the other PR just went in.

Comment thread doc/custom_conf.py
Comment thread doc/custom_conf.py
Comment thread doc/reference/releases-snaps.md Outdated
Comment thread doc/reference/releases-snaps.md Outdated
Comment thread doc/reference/releases-snaps.md Outdated
Comment thread doc/how-to/install.md
Comment thread doc/how-to/update_upgrade.md Outdated
Comment thread doc/how-to/snaps.md
Comment thread doc/how-to/update_upgrade.md Outdated
@minaelee
minaelee force-pushed the releases-snap branch 2 times, most recently from edc7bc6 to a115f71 Compare June 29, 2025 20:39
@minaelee

Copy link
Copy Markdown
Author

Test won't pass until #839 is merged. Will rebase after.

roosterfish
roosterfish previously approved these changes Jun 30, 2025

@roosterfish roosterfish left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@minaelee
minaelee force-pushed the releases-snap branch 2 times, most recently from 0442198 to 83c3966 Compare June 30, 2025 15:00
@minaelee
minaelee requested a review from roosterfish June 30, 2025 15:07
@minaelee

Copy link
Copy Markdown
Author

Updated the compatibility matrix to include feature releases:

Supported and compatible releases

:align: center

| Ubuntu LTS | MicroCloud  | LXD        | MicroCeph       | MicroOVN |
| ---------- | ----------- | ---------- | --------------- | -------- |
| 22.04      | 2.1*        | 5.21*      | Squid           | 24.03    |
| 24.04      | 2.1*        | 5.21*      | Squid           | 24.03    |

* For MicroCloud and LXD, the most recent {ref}feature releases <ref-releases-microcloud-feature> (after the last LTS) are also supported.

Minae Lee added 6 commits June 30, 2025 08:47
…snaps

Signed-off-by: Minae Lee <minae.lee@canonical.com>
Signed-off-by: Minae Lee <minae.lee@canonical.com>
Signed-off-by: Minae Lee <minae.lee@canonical.com>
Signed-off-by: Minae Lee <minae.lee@canonical.com>
Signed-off-by: Minae Lee <minae.lee@canonical.com>
Signed-off-by: Minae Lee <minae.lee@canonical.com>
@roosterfish
roosterfish merged commit f629423 into canonical:main Jun 30, 2025
15 checks passed
@roosterfish roosterfish mentioned this pull request Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants