Skip to content

doc: Update MicroCeph URL for intersphinx extension#1382

Merged
roosterfish merged 1 commit into
canonical:mainfrom
elijahgreenstein:update-microceph-url
May 15, 2026
Merged

doc: Update MicroCeph URL for intersphinx extension#1382
roosterfish merged 1 commit into
canonical:mainfrom
elijahgreenstein:update-microceph-url

Conversation

@elijahgreenstein
Copy link
Copy Markdown
Contributor

@elijahgreenstein elijahgreenstein commented May 14, 2026

MicroCeph has been migrated from Read the Docs to https://documentation.ubuntu.com/canonical-microceph/latest/. This PR updates custom_conf.py so that the MicroCeph objects.inv file can be accessed from the new URL. The objects.inv file is used by the intersphinx extension for cross references to MicroCeph documentation.

Checklist

@github-actions github-actions Bot added the Documentation Documentation needs updating label May 14, 2026
@elijahgreenstein elijahgreenstein changed the title doc: Update MicroCeph URL (remove en) doc: Update MicroCeph URL for intersphinx extensoin May 14, 2026
@elijahgreenstein elijahgreenstein changed the title doc: Update MicroCeph URL for intersphinx extensoin doc: Update MicroCeph URL for intersphinx extension May 14, 2026
@elijahgreenstein elijahgreenstein marked this pull request as ready for review May 14, 2026 16:57
The MicroCeph URL has changed from Read the Docs to
`documentation.ubuntu.com`. This commit updates `custom_conf.py` so that
the MicroCeph `objects.inv` file can be accessed from the new URL.

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
@roosterfish roosterfish merged commit a22749c into canonical:main May 15, 2026
27 of 28 checks passed
@elijahgreenstein elijahgreenstein deleted the update-microceph-url branch May 21, 2026 17:30
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.
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