Early Bird Registration for DrupalCon Portland 2024 is open! Register by 23:59 PST on 31 March 2024, to get $100 off your ticket.
Problem/Motivation
Follow up from #3143115-13: README.txt file format for Drupal . README.txt contains a link specific to Drupal 8.
https://www.drupal.org/docs/8/distributions/creating-distributions
https://www.drupal.org/docs/8/creating-distributions
https://www.drupal.org/docs/8/theming
https://api.drupal.org/api/drupal/8
Proposed resolution
I propose to change the link to https://www.drupal.org/docs/theming-drupal
Remaining tasks
Verify it
fix it
review it
Commit it
User interface changes
None
API changes
None
Data model changes
None
Release notes snippet
None
Comment | File | Size | Author |
---|---|---|---|
#8 | updated-readme-links-3143482-8.patch | 5.57 KB | atul4drupal |
Comments
Comment #2
Sivaji_Ganesh_Jojodae CreditAttribution: Sivaji_Ganesh_Jojodae as a volunteer and commentedComment #3
atul4drupal CreditAttribution: atul4drupal at Srijan | A Material+ Company for Drupal India Association commentedComment #4
atul4drupal CreditAttribution: atul4drupal at Srijan | A Material+ Company for Drupal India Association commentedThanks for this issue ... I think we must wait for the issue at https://www.drupal.org/project/drupal/issues/3143115 to be fixed and committed before rolling any patch to this issue as this will otherwise conflict with the issue mentioned before.
Also I recommend broadening the scope to update all obsolete links in README file, as there are several links that may be updated to point to latest resource/page.
Comment #5
Sivaji_Ganesh_Jojodae CreditAttribution: Sivaji_Ganesh_Jojodae as a volunteer and commentedI agree with you & have updated the issue summary accordingly.
Realizing that I was originally referring to CHANGELOG.txt which is a separate issue reported here #3143196: Change the download link in CHANGELOG.txt for Drupal 9.
Comment #6
Sivaji_Ganesh_Jojodae CreditAttribution: Sivaji_Ganesh_Jojodae as a volunteer and commentedComment #7
atul4drupal CreditAttribution: atul4drupal at Srijan | A Material+ Company for Drupal India Association commentedThanks DevJoJodae for the scope expansion.
Actally its my bad to have this postponed, seems I had over thought about the conflict thing which is not true with this issue.
Comment #8
atul4drupal CreditAttribution: atul4drupal at Srijan | A Material+ Company for Drupal India Association commentedAdding patch for review.
Comment #10
longwaveI wonder if it's worth adding a test that checks that all URLs in these files are valid and land on a page (rather than a redirect).
Comment #11
Sivaji_Ganesh_Jojodae CreditAttribution: Sivaji_Ganesh_Jojodae as a volunteer and commentedComment #12
atul4drupal CreditAttribution: atul4drupal at Srijan | A Material+ Company for Drupal India Association commentedComment #13
nitvirus CreditAttribution: nitvirus at Srijan | A Material+ Company commentedAssigning to myself
Comment #14
nitvirus CreditAttribution: nitvirus at Srijan | A Material+ Company commentedSteps taken to check:
1. Applied the patch.-- patch applied cleanly
2. checked for any other links which might have been left in the patch
Found that the URL to best practices (https://www.drupal.org/best-practices) redirects to https://www.drupal.org/docs/7/site-building-best-practices/best-practices
The url should be cleaned, other than that patch looks fine.
changing status to RTBC
Comment #15
nitvirus CreditAttribution: nitvirus at Srijan | A Material+ Company commentedComment #16
xjmThese don't seem to have anything to do with the scope in the issue title. Are we just relabeling them to avoid redirects?
I see in #4 that that's the idea. Retitling accordingly.
Comment #19
xjmWith the expanded scope, I reviewed this to check that all the links on the removed lines in the patch redirect to the links on the corresponding added lines. I similarly checked the few URLs not changed by this patch and verified that they don't redirect to anything else, with the exception of the
best-practices
link that @nitvirus mentioned. (It's in the D7 handbook, but the best practices are relevant for Drupal 8+ as well and are a good high-level introduction, so I think it's OK to retain this link in its aliased, non-D7 version.)This is the only link in the patch that is not simply a redirect and not. Weirdly, the
/8
suffix takes me to 8.2.x docs?! I pinged @drumm about that.Committed to 9.1.x and 9.0.x. I didn't backport it to 8.9.x because of the API docs link. I did debate backporting it anyway because the 9.0.x API is closer to Drupal 8.9.x than 8.2.x's is. 😂.
Setting "Patch (to be ported)" for an 8.9.x version. We could do one of:
api.d.o/api/drupal/8
redirects to something less stupid./8
from the end which seems to be 8.8.x docs currently (but it may not always be, so I think 1 or 2 are better choices).Thanks!
Comment #20
nitvirus CreditAttribution: nitvirus at Srijan | A Material+ Company commentedI like the 2nd approach better, we know we have put in a hardcoded url but there is no dependency on infra.
Comment #21
Matroskeen8.9.x receives only security updates, so there is nothing to do here.
@larowlan:
Comment #22
Matroskeen