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

Fix linkcheck #11940

Merged
merged 2 commits into from
Jul 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,5 @@ jobs:
woke-args: "*.md **/*.md -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"

- name: Run link checker
# This can fail intermittently due to external resources being unavailable.
Copy link
Member

Choose a reason for hiding this comment

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

Please can we keep this in so that if an external web site is down/unreachable it doesnt prevent the rest of the tests from running. I added this because we periodically get this job fail because the web site in question is down/unreachable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See the commit message - this is now the last of the test, so all other tests will run. If we add further tests, we can add them with "always()" so they still run.
If we don't fail this test, we will NEVER see if a link breaks, and we can just as well get rid of the test.

Copy link
Member

Choose a reason for hiding this comment

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

Does not show it as red/failed in the test results then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the linkcheck will show as red - but that shouldn't prevent from merging?

Copy link
Member

Choose a reason for hiding this comment

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

OK will merge this now and if we see it causing issues again in the future we can review then.

continue-on-error: true
run: |
make doc-linkcheck
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@

linkcheck_ignore = [
'https://127.0.0.1:8443/1.0',
'https://web.libera.chat/#lxc'
'https://web.libera.chat/#lxd'
]

# Setup redirects (https://documatt.gitlab.io/sphinx-reredirects/usage.html)
Expand Down
2 changes: 1 addition & 1 deletion doc/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ LXD publishes and tests [snap packages](https://snapcraft.io/lxd) that work for

Complete the following steps to install the snap:

1. Check the [provided distributions](https://jenkins.linuxcontainers.org/job/lxd-test-snap-latest-stable/) to see if a snap is available for your Linux distribution.
1. Check the [LXD snap page on Snapcraft](https://snapcraft.io/lxd) to see if a snap is available for your Linux distribution.
If it is not, use one of the {ref}`installing-other`.

1. Install `snapd`.
Expand Down