Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: prevent transclusion issues #1021

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

medubelko
Copy link
Contributor

@medubelko medubelko commented Feb 20, 2025

Prevents some issues with the docs in downstream apps. See commit messages for details.


  • Have you signed the CLA?
  • Have you added an entry to the changelog (docs/reference/changelog.rst)?

Since craft apps slice and dice these pages through includes, it's
better if any links in the text are portable.
"UV plugin" has refs to "Python plugin". This causes circular problems
in downstream apps that transclude parts of both pages. At the moment
Charmcraf is affected. It's best to altogether avoid interlinking in the
main body of the pages.
Copy link
Contributor

@bepri bepri left a comment

Choose a reason for hiding this comment

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

Makes sense, thanks for figuring out and fixing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants