Skip to content

fix: remove references to recently archived site#502

Merged
medubelko merged 1 commit into
devfrom
remove-links-to-archived-site
Jan 27, 2026
Merged

fix: remove references to recently archived site#502
medubelko merged 1 commit into
devfrom
remove-links-to-archived-site

Conversation

@minaelee

@minaelee minaelee commented Jan 19, 2026

Copy link
Copy Markdown

The site https://canonical-example-product-documentation.readthedocs-hosted.com/ was recently deleted. This commit removes all links and references to that site, including replacing its use in demonstrating intersphinx use in the documentation with a different site.

Note that the deleted site has been temporarily re-created to prevent build failures from numerous sites that link to it. However, this is only a temporarily measure and those sites should also update their links to avoid future issues.

Closes #501


  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

@minaelee minaelee force-pushed the remove-links-to-archived-site branch 3 times, most recently from 9f6636b to ee8f519 Compare January 19, 2026 23:15
Comment thread docs/reference/rst-syntax-reference.rst Outdated
@minaelee minaelee force-pushed the remove-links-to-archived-site branch from ee8f519 to b6913ae Compare January 19, 2026 23:21
@minaelee

minaelee commented Jan 19, 2026

Copy link
Copy Markdown
Author

The check for removed URLs will fail no matter what due to its trying to build the existing main branch to compare against the PR branch, where the main branch has the errors this PR branch fixes.

Edit: It passes now because I made the deleted RTD project available again.

@minaelee minaelee force-pushed the remove-links-to-archived-site branch from b6913ae to 611fa18 Compare January 19, 2026 23:26
Comment thread docs/conf.py Outdated
Comment thread docs/reference/rst-syntax-reference.rst Outdated
Comment thread docs/reference/rst-syntax-reference.rst Outdated
@minaelee minaelee marked this pull request as ready for review January 19, 2026 23:30
@minaelee minaelee force-pushed the remove-links-to-archived-site branch from 611fa18 to f8da7f4 Compare January 20, 2026 00:19
@minaelee

Copy link
Copy Markdown
Author

I need to fix a couple links still but need to run for a bit. Will fix when I return.

@minaelee minaelee marked this pull request as draft January 20, 2026 00:22
@minaelee minaelee force-pushed the remove-links-to-archived-site branch 4 times, most recently from 173e89f to 3cb49e3 Compare January 20, 2026 03:00
@minaelee minaelee marked this pull request as ready for review January 20, 2026 03:19
@minaelee minaelee requested review from izmalk and medubelko January 20, 2026 03:19

@medubelko medubelko left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Code LGTM. Needs a rebase.

@minaelee Since this is no longer needed as a hotfix, what do you think about pulling this against dev?

@medubelko medubelko added the On hold This indicates a decision needs to be made internally before this issue can be addressed fully. label Jan 20, 2026
@minaelee minaelee marked this pull request as draft January 26, 2026 17:51
@minaelee minaelee force-pushed the remove-links-to-archived-site branch from 3cb49e3 to 2720809 Compare January 26, 2026 18:29
@minaelee minaelee changed the base branch from main to dev January 26, 2026 18:30
@minaelee

Copy link
Copy Markdown
Author

Code LGTM. Needs a rebase.

@minaelee Since this is no longer needed as a hotfix, what do you think about pulling this against dev?

Sounds good, rebased against dev.

@minaelee minaelee marked this pull request as ready for review January 26, 2026 18:30

@medubelko medubelko left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, with one suggestion for readability.

Comment thread docs/reference/myst-syntax-reference.md Outdated
@minaelee minaelee force-pushed the remove-links-to-archived-site branch from 2720809 to 4ea9662 Compare January 26, 2026 20:20
Comment thread docs/reference/rst-syntax-reference.rst
@minaelee minaelee removed the On hold This indicates a decision needs to be made internally before this issue can be addressed fully. label Jan 26, 2026
The site https://canonical-example-product-documentation.readthedocs-hosted.com/
was recently deleted. This commit removes all links and references to that site.
It also updates its use in demonstrating intersphinx use in the documentation
with example syntax instead of a real link to protect against future link rot.

Note that the deleted site has been temporarily re-created to prevent build
failures from numerous sites that link to it. However, this is only a temporarily
measure and those sites should also update their links to avoid future issues.

Signed-off-by: Minae Lee <minae.lee@canonical.com>
@minaelee minaelee force-pushed the remove-links-to-archived-site branch from 4ea9662 to ab89b8b Compare January 26, 2026 22:51
@minaelee minaelee requested a review from medubelko January 27, 2026 16:10
@medubelko medubelko merged commit dc50e40 into dev Jan 27, 2026
4 of 5 checks passed
@medubelko medubelko deleted the remove-links-to-archived-site branch February 20, 2026 17:51
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.

Example-product docs are used in links but no longer available

3 participants