Skip to content

docs: update external urls which were being redirected#3337

Merged
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-update-external-url-redirects
Jan 17, 2025
Merged

docs: update external urls which were being redirected#3337
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-update-external-url-redirects

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

@reubenmiller reubenmiller commented Jan 17, 2025

Proposed changes

Update external URLs which were being automatically redirected to ensure that the links don't break when such redirection is removed by the external website.

The redirected URLs were found by using becheran/mlc

cargo install mlc
mlc --gitignore --root-dir . --throttle 100

Whilst this is not critical work it ensures that our documentation stays up to date.

Notes:

  • https://www.identrust.com/dst-root-ca-x3 is still being redirected, but I haven't been able to find a suitable replacement yet
  • Raspberry Pi website links (https://www.raspberrypi.com) register as false positives in mlc as it seems their website prevents crawlers/spiders and the mlc client returns a HTTP 403 when trying to verify the links, but the links can be manually verified in the browser

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Jan 17, 2025
Copy link
Copy Markdown
Member

@rina23q rina23q left a comment

Choose a reason for hiding this comment

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

The links to Azure doc even redirected me to another URL...

Copy link
Copy Markdown
Member

@rina23q rina23q left a comment

Choose a reason for hiding this comment

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

Approved

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 17, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
553 0 2 553 100 1h30m46.039682999s

@reubenmiller
Copy link
Copy Markdown
Contributor Author

Approved

Thanks for catching a few of those URLs, I've addressed your comments now.

@reubenmiller reubenmiller force-pushed the docs-update-external-url-redirects branch from 383287c to 3ebedd4 Compare January 17, 2025 14:39
@reubenmiller reubenmiller added this pull request to the merge queue Jan 17, 2025
Merged via the queue into thin-edge:main with commit 630aa39 Jan 17, 2025
@reubenmiller reubenmiller deleted the docs-update-external-url-redirects branch January 17, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants