Skip to content

docs,internal,etc: update LXD docs URLs - #972

Open
elijahgreenstein wants to merge 1 commit into
canonical:mainfrom
elijahgreenstein:update-urls
Open

docs,internal,etc: update LXD docs URLs#972
elijahgreenstein wants to merge 1 commit into
canonical:mainfrom
elijahgreenstein:update-urls

Conversation

@elijahgreenstein

Copy link
Copy Markdown

Description

LXD docs are now at https://canonical.com/lxd/docs/.

Docs

Procedure:

  • I have checked and added or updated relevant documentation.
  • I have checked and added or updated relevant release notes.
  • I have included the technical author in the review.

LXD docs are now at https://canonical.com/lxd/docs/.

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
@akcano
akcano self-requested a review August 10, 2026 11:28
@dmitry-lyfar

Copy link
Copy Markdown
Collaborator

@elijahgreenstein thanks for the update, please note that it breaks 3 unit tests with error messages that give the link to the LXD docs.

Copilot AI 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.

Pull request overview

Updates hard-coded links to LXD documentation across Workshop’s Go code and Sphinx/Markdown documentation to reflect Canonical’s new LXD docs location (https://canonical.com/lxd/docs/).

Changes:

  • Replaced legacy documentation.ubuntu.com/lxd/... URLs with canonical.com/lxd/docs/... in user-facing docs and internal comments.
  • Updated shared documentation link definitions (Sphinx rst_epilog and style guides) to point at the new LXD docs base.
  • Refreshed various tutorial/reference pointers to keep external links consistent.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
internal/workshop/lxd/firewall.go Updates firewall troubleshooting doc link to the new LXD docs host.
internal/interfaces/lxd_device/spec.go Updates proxy-device documentation reference URL.
docs/tutorial/part-4-craft-sdks.rst Updates tutorial links to LXD REST API and installation/daemon docs.
docs/tutorial/part-1-get-started.rst Updates onboarding tutorial links to LXD REST API and installation/daemon docs.
docs/security.md Updates LXD and projects documentation links in security overview.
docs/reference/workshops.rst Updates storage-pools documentation link.
docs/index.rst Updates home-page related links list for LXD.
docs/how-to/fix-workshops/fix-installation.rst Updates troubleshooting-guide link.
docs/doc-style-guide.md Updates example/reference LXD link used in documentation guidance.
docs/contributing/maintenance.rst Updates LXD link used in maintenance/build instructions.
docs/conf.py Updates Sphinx rst_epilog link targets for LXC/LXD.
cmd/workshop/exec.go Updates inline comment URL describing lxc exec behavior.
.github/skills/documentation-style/references/doc-style-guide.md Mirrors doc style guide link updates in the skill reference copy.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/index.rst
@@ -1,5 +1,5 @@
:slug: home-page
:relatedlinks: [Workshop](https://github.com/canonical/workshop/), [SDKcraft](https://github.com/canonical/sdkcraft/), [LXD](https://documentation.ubuntu.com/lxd/default/), [Snap](https://snapcraft.io/docs/)
:relatedlinks: [Workshop](https://github.com/canonical/workshop/), [SDKcraft](https://github.com/canonical/sdkcraft/), [LXD](https://canonical.com/lxd/docs/default/), [Snap](https://snapcraft.io/docs/)
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.

4 participants