Skip to content

Commit

Permalink
doc: embed discourse post title as link text (#14295)
Browse files Browse the repository at this point in the history
This PR explicitly specifies the link text for Discourse posts (from the
posts' titles) instead of extracting it at build time. Recent Discourse
outages have caused build failures when the link text couldn't be
fetched dynamically. Hard-setting the link text should prevent this.

**Note:** Docs on specifying link text
[here](https://github.com/canonical/canonical-sphinx-extensions/?tab=readme-ov-file#specify-links-for-a-page).
The docs also describes a backup link text option, but I did not use it
due to buggy behavior. _My expectation:_ The backup link text will be
used if the link text cannot be extracted dynamically, and the build
will not fail. _Reality:_ The backup link text is recognized, yet the
build still fails.
  • Loading branch information
tomponline authored Oct 18, 2024
2 parents c74a664 + 3fa5324 commit 69640d9
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/explanation/authorization.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: ubuntu:41516
discourse: ubuntu:[Identity and Access Management for LXD](41516)
---

(authorization)=
Expand Down
2 changes: 1 addition & 1 deletion doc/howto/snap.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: ubuntu:37214
discourse: ubuntu:[Managing the LXD snap package](37214)
---

(howto-snap)=
Expand Down
2 changes: 1 addition & 1 deletion doc/installing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: ubuntu:37327
discourse: ubuntu:[Building custom LXD binaries for side loading into an existing snap installation](37327)
---

(installing)=
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/remote_image_servers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: ubuntu:43824,16647
discourse: ubuntu:[New LXD image server available (images.lxd.canonical.com)](43824),[Image server infrastructure](16647)
relatedlinks: https://www.youtube.com/watch?v=pM0EgUqj2a0
---

Expand Down
2 changes: 1 addition & 1 deletion doc/reference/uefi_variables.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
discourse: ubuntu:42313
discourse: ubuntu:[LXD VM instance EFI Variables edit CLI](42313)
---

# UEFI variables for VMs
Expand Down

0 comments on commit 69640d9

Please sign in to comment.