doc: Pin MicroCeph squid (v2-edge)#1344
Conversation
The Ceph team cut the squid branch now as they started to work on the tentacle release in the main branch. Signed-off-by: Julian Pelizäus <julian.pelizaeus@canonical.com>
roosterfish
changed the title
Signed-off-by: Minae Lee <minae.lee@canonical.com> (cherry picked from commit 950ae87)
|
@minaelee we can now pin MicroCeph. As part of this I am including a commit which I have skipped previously as it failed the link check. |
|
If we are not including this commit, the RTD job fails with: |
We discussed this f2f but noting here for posterity that this failure is due to the fact that for the GH CI check, to avoid having to clone and build all integrated docs for every PR, we use the MicroCeph objects.inv file from their https://canonical-microceph.readthedocs-hosted.com/en/v19.2.0-squid/ version. This file currently differs from the objects.inv created by cloning and building MicroCeph from its new This means that since the RTD build uses the |
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.
2 participants
I just saw the branch is available so we should start pinning it to not slide any tentacle docs into 2 LTS.