Update redirecting URLs in bundled library metadata #793
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `url` field of the `library.properties` metadata file points the user to where they might find more information or
assistance for the library.
This platform includes bundled libraries which are variants of the standardized libraries distributed by Arduino. The
`url` field in the metadata of these libraries points to the reference on the arduino.cc website, as that information is
also applicable to this platform's variants of the libraries.
Due to restructuring of the arduino.cc website, the targeted reference pages have moved to a different URL. Arduino set
up redirects from the previous URLs to the new one, but redirects have a tendency to break or no longer lead to the
intended target over time so it is best to avoid relying on them. In addition, the use of redirecting URLs seems to make
it more likely that automated link checks will fail due to an HTTP 403 ("Forbidden") response code, even though the URL
does work as expected when a human loads it in their browser.
SpenceKonde
merged commit 1747efb
into
SpenceKonde:v2.0.0-devThis-is-the-head-submit-PRs-against-this
45 of 55 checks passed
|
Thanks!!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
urlfield of thelibrary.propertiesmetadata file points the user to where they might find more information or assistance for the library.This platform includes bundled libraries which are variants of the standardized libraries distributed by Arduino. The
urlfield in the metadata of these libraries points to the reference on the arduino.cc website, as that information is also applicable to this platform's variants of the libraries.Due to restructuring of the arduino.cc website, the targeted reference pages have moved to a different URL. Arduino set up redirects from the previous URLs to the new one, but redirects have a tendency to break or no longer lead to the intended target over time so it is best to avoid relying on them. In addition, the use of redirecting URLs seems to make it more likely that automated link checks will fail (per1234/arduino-ci-script#33) due to an HTTP 403 ("Forbidden") response code:
https://github.com/SpenceKonde/ATTinyCore/actions/runs/5339900593/jobs/9679095711
even though the URL does work as expected when a human loads it in their browser:
http://www.arduino.cc/en/Reference/Wire