Skip to content

Fix broken links in documentation #304

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

Merged
merged 2 commits into from
Jul 2, 2023
Merged

Fix broken links in documentation #304

merged 2 commits into from
Jul 2, 2023

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 2, 2023

The previous targets of these links were no longer available on the Internet.

Originally reported at: https://forum.arduino.cc/t/ble-standard-services-link-forbidden/1143581

per1234 added 2 commits July 2, 2023 07:39
The file previously targeted by the embed has been lost or moved. Experience shows that this is is a common occurrence
with the files hosted by Arduino, and will be especially problematic in cases like this where the file may appear to be
superfluous to the website maintainers due to the lack of any internal references to it, so the only way to ensure the
file will continue to be available is by hosting alongside the documentation content in the repository.

I was able to recover the lost file from the Internet Archive Wayback Machine's 2023-06-18 archive of the previous URL:

https://web.archive.org/web/20230618230604/https://www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png

The absolute URL of the file was intentionally used in the markup instead of what would normally be the best practices
of using the relative path. The reason is because the documentation content will be published at
https://reference.arduino.cc/reference/en/libraries/arduinoble/ and the publishing system doesn't have any capability
for handling asset files.
The previous target of this link is no longer available.

I found that there is no longer an authoritative web page that provides a list of standard GATT service UUIDs, equivalent to the previous target of that link:

https://web.archive.org/web/20160305021019/https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx

The Bluetooth Special Interest Group has since moved this information into the "Assigned Numbers" pdf, so I replaced the
broken link with a link to the download page for that document and noted its location in that document.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Jul 2, 2023
@per1234 per1234 merged commit 726a6c8 into arduino-libraries:master Jul 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant