Problem/Motivation
There is no process in place to ensure that the documentation links in core are correct.
Steps to reproduce
Upload script, checkurls.sh_.txt
Run script
Output file all_urls.txt lists all the URLs in core
Output file non_200_urls.csv is a CSV file with the URL and status for non 200 URLs.
Optionally, update the spreadsheet.
Proposed resolution
Make child issues as needed.
https://www.drupal.org/files/projects/drupal-x.y.z.tar.gz is being fixed in #3086655: Add composer instructions to INSTALL.txt
Remaining tasks
Upload script from #2855175: [META] Many documentation / handbook URLs redirect to D7 content
Run script
Update spreadsheet
See child issues
Decide on a way to keep the URLs up to date
User interface changes
Introduced terminology
API changes
Data model changes
Release notes snippet
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | checkurls.sh_.txt | 1.14 KB | quietone |
Comments
Comment #2
quietone commentedI just ran the script and found 26 links that are 404 where 3 of those do not have a status. The results are in a sheet, dated today.
Comment #3
quietone commentedUsed in Tests
Do not need to be changed
Remaining to be fixed, not in #3553528: Fix documenation URLs that are 404, part 1
Comment #4
quietone commentedComment #5
nicxvan commentedThis is likely related even if it's more for deprecated messages: #3560560: Fix deprecated messages that reference issue instead of change record
Comment #6
quietone commentedComment #7
quietone commentedComment #8
nicxvan commentedShould we make this one of the checks in ci?
Comment #9
quietone commentedThat is a good idea but it would also have to not report an error for, at least the following.
Comment #10
quietone commentedI ran the script with #3560560: Fix deprecated messages that reference issue instead of change record and found a 404 related to those deprecation, so I have updated that issue. Also reported was a URL that was
fixed in #3553528: Fix documenation URLs that are 404, part 1. Obviously that fix was incorrect. The change should be
The correct URL for \Drupal\Tests\package_manager\Kernel\TestSandboxManager::__sleep() doc bloc is https://www.drupal.org/project/automatic_updates/issues/3312619#comment-....
Comment #12
quietone commentedRan the script today on main, with the following results.
Of those, 2 need to be fixed and there are issues for them
Comment #13
quietone commentedAll the child issues are closed.
I ran the script on main and there were 215 URLS that are not a 200, but none that are a 404. So, while the link works we don't know for sure that it is directing to the correct place according to the comment it may be in. But to check each of those is impractical. Instead, we should rely on the community to make an issue when they find one that is incorrect. Therefor, I think we should close this issue.
Also, this script should be run regularly. I suggest that this be added to the Drupal 13 beta requirements issue, in an 'other' section. Since it is already listed in the Drupal 12 issue, then an item for it will be created in the Drupal 13 issue because the Drupal 13 issue is based on the Drupal 12 one.
Comment #14
xjmI guess this was listed as a beta requirement rather than an RC requirement since some of these URLs are user-facing?
I added a bullet to the D13 meta that we can make part of the standard template. Since all children are done for D12, marking fixed here.