Skip to content

fix(doc-links test): improve test to get list of broken links#1915

Merged
kimanhou merged 1 commit intocanonical:mainfrom
kimanhou:fix-doc-links
Apr 6, 2026
Merged

fix(doc-links test): improve test to get list of broken links#1915
kimanhou merged 1 commit intocanonical:mainfrom
kimanhou:fix-doc-links

Conversation

@kimanhou
Copy link
Copy Markdown
Contributor

@kimanhou kimanhou commented Apr 2, 2026

Done

  • fix(doc-links): improve the test that checks in all documentation links exist and are healthy

QA

  1. Run the LXD-UI:
  2. Perform the following QA steps:
    • At the of opening this PR, the docs seem broken in LXD latest edge so the test should fail and log the full list of broken links with their status
    Error: Found 26 broken documentation links:
   [501] /explanation/authorization
   [501] /explanation/authorization/#use-groups-defined-by-the-identity-provider
   [501] /explanation/clustering/
   [501] /explanation/clusters/#member-roles
   [501] /explanation/networks/
   [501] /explanation/storage/
   [501] /explanation/storage/#storage-buckets
   [501] /explanation/storage/#storage-pools
   [501] /explanation/storage/#storage-volumes
   [501] /howto/cluster_placement_groups/
   [501] /howto/container_gpu_passthrough_with_docker/#container-gpu-passthrough-with-docker
   [501] /howto/instances_create/
   [501] /howto/instances_create/#instances-create-iso
   [501] /howto/network_acls/
   [501] /howto/network_forwards/
   [501] /howto/network_ipam/
   [501] /howto/network_ipam/#view-dhcp-leases-for-fully-controlled-networks
   [501] /howto/network_ovn_setup/#set-up-a-lxd-cluster-on-ovn
   [501] /howto/oidc
   [501] /howto/oidc/
   [501] /howto/storage_backup_volume/#storage-backup-snapshots
   [501] /howto/storage_buckets/#manage-storage-bucket-keys
   [501] /reference/devices_gpu/#devices-gpu
   [501] /reference/instance_options/#instance-options-snapshots-names
   [501] /reference/storage_btrfs/#quotas
   [501] /reference/storage_dir/#quotas

@webteam-app
Copy link
Copy Markdown

@kimanhou
Copy link
Copy Markdown
Contributor Author

kimanhou commented Apr 3, 2026

The test fails because it claims the documentation page explanation/authorization returns a 501 Not Implemented error:

Error: ✗ /explanation/authorization - NOT FOUND (501)

But the page does exist
image
image

@kimanhou kimanhou changed the title fix(doc-links): remove test.fail fix(doc-links test): improve test to get list of broken links Apr 3, 2026
@kimanhou kimanhou marked this pull request as ready for review April 3, 2026 10:15
Signed-off-by: Kim Anh Nguyen <4783194+kimanhou@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@omarelkashef omarelkashef left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for fixing the test!

@kimanhou kimanhou merged commit 05281d2 into canonical:main Apr 6, 2026
16 of 18 checks passed
@kimanhou kimanhou deleted the fix-doc-links branch April 6, 2026 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants