Skip to content

doc: fix internal link targets - #896

Merged
roosterfish merged 1 commit into
canonical:mainfrom
minaelee:fix-internal-links
Jul 25, 2025
Merged

doc: fix internal link targets#896
roosterfish merged 1 commit into
canonical:mainfrom
minaelee:fix-internal-links

Conversation

@minaelee

Copy link
Copy Markdown

This PR fixes link targets that are intended to point to MicroCloud internal docs but are pointing at LXD's docs through intersphinx. Due to the link targets existing in LXD latest branch, the links did not raise an error, but the issue showed up in a backport PR where the LXD branch used in the backport (stable-5.21) does not yet have those link targets.

Signed-off-by: Minae Lee <minae.lee@canonical.com>
@github-actions github-actions Bot added the Documentation Documentation needs updating label Jul 25, 2025
@minaelee minaelee mentioned this pull request Jul 25, 2025
@minaelee
minaelee requested a review from roosterfish July 25, 2025 16:23

@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.

Good catch! Just to clarify, in case there are two refs with the same name on both LXD and MC, does the one from MC take precedence?

@roosterfish
roosterfish merged commit 484c74d into canonical:main Jul 25, 2025
15 checks passed
@roosterfish

Copy link
Copy Markdown
Contributor

Can we prefix the ones coming from LXD?

@minaelee

Copy link
Copy Markdown
Author

Good catch! Just to clarify, in case there are two refs with the same name on both LXD and MC, does the one from MC take precedence?

Yes, if no prefix is set (like lxd:), intersphinx will only look in other docs sets if doesn't find the link in MC first.

@minaelee

Copy link
Copy Markdown
Author

Can we prefix the ones coming from LXD?

They are already prefixed, but the issue is that those links don't yet exist in LXD stable-5.21 because those docs haven't been backported. Working on that backport now!

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