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

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

DevJoJodae created an issue. See original summary.

Sivaji_Ganesh_Jojodae’s picture

Title: Change the README.txt file in CHANGELOG.txt to Drupal 9 » Change the "More about themes" section link in README.txt to Drupal 9
atul4drupal’s picture

Assigned: Unassigned » atul4drupal
atul4drupal’s picture

Component: meetings » documentation
Assigned: atul4drupal » Unassigned
Status: Active » Postponed
Issue tags: +Needs documentation updates, +Novice

Thanks 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.

Sivaji_Ganesh_Jojodae’s picture

Issue summary: View changes

I 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.

Sivaji_Ganesh_Jojodae’s picture

Title: Change the "More about themes" section link in README.txt to Drupal 9 » Change the Drupal 8 specific links in README.txt to Drupal 9
atul4drupal’s picture

Assigned: Unassigned » atul4drupal
Status: Postponed » Active

Thanks 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.

atul4drupal’s picture

Assigned: atul4drupal » Unassigned
Status: Active » Needs review
FileSize
5.57 KB

Adding patch for review.

Status: Needs review » Needs work

The last submitted patch, 8: updated-readme-links-3143482-8.patch, failed testing. View results

longwave’s picture

I 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).

Sivaji_Ganesh_Jojodae’s picture

atul4drupal’s picture

Status: Needs work » Needs review
nitvirus’s picture

Assigned: Unassigned » nitvirus

Assigning to myself

nitvirus’s picture

Status: Needs review » Reviewed & tested by the community

Steps 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

nitvirus’s picture

Assigned: nitvirus » Unassigned
xjm’s picture

Title: Change the Drupal 8 specific links in README.txt to Drupal 9 » Replace README.txt links that have a redirect with the preferred URL (including removing stale references to Drupal 8 docs)
+++ b/README.txt
@@ -45,7 +45,7 @@ More about configuration:
-   https://www.drupal.org/project/modules
+   https://www.drupal.org/project/project_module

@@ -70,11 +70,11 @@ the required extensions separately; place the downloaded profile in the
-   https://www.drupal.org/project/distributions
+   https://www.drupal.org/project/project_distribution

@@ -87,9 +87,9 @@ custom theme.
-   https://www.drupal.org/project/themes
+   https://www.drupal.org/project/project_theme

@@ -111,15 +111,15 @@ when nothing existing comes close to what you need.
-   https://www.drupal.org/project/modules
+   https://www.drupal.org/project/project_module
...
-   https://www.drupal.org/developing/best-practices
+   https://www.drupal.org/docs/develop/standards

@@ -136,7 +136,7 @@ MORE INFORMATION
-   "Security team" page at https://www.drupal.org/security-team
+   "Security team" page at https://www.drupal.org/drupal-security-team

+++ b/core/assets/scaffold/files/drupal.README.txt
@@ -45,7 +45,7 @@ More about configuration:
-   https://www.drupal.org/project/modules
+   https://www.drupal.org/project/project_module

@@ -70,11 +70,11 @@ the required extensions separately; place the downloaded profile in the
-   https://www.drupal.org/project/distributions
+   https://www.drupal.org/project/project_distribution

@@ -87,9 +87,9 @@ custom theme.
-   https://www.drupal.org/project/themes
+   https://www.drupal.org/project/project_theme

@@ -111,15 +111,15 @@ when nothing existing comes close to what you need.
-   https://www.drupal.org/project/modules
+   https://www.drupal.org/project/project_module
...
-   https://www.drupal.org/developing/best-practices
+   https://www.drupal.org/docs/develop/standards

@@ -136,7 +136,7 @@ MORE INFORMATION
-   "Security team" page at https://www.drupal.org/security-team
+   "Security team" page at https://www.drupal.org/drupal-security-team

These 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.

  • xjm committed 5c96d91 on 9.1.x
    Issue #3143482 by atul4drupal, nitvirus: Replace README.txt links that...

  • xjm committed 4d51aab on 9.0.x
    Issue #3143482 by atul4drupal, nitvirus: Replace README.txt links that...
xjm’s picture

Version: 9.1.x-dev » 8.9.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)

With 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.)

+++ b/README.txt
@@ -111,15 +111,15 @@ when nothing existing comes close to what you need.
-   https://api.drupal.org/api/drupal/8
+   https://api.drupal.org/api/drupal/9

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:

  1. Just removing the change to that line from the patch, in the hope and expectation that infra will fix it so api.d.o/api/drupal/8 redirects to something less stupid.
  2. Linking the 8.9.x docs directly: https://api.drupal.org/api/drupal/8.9.x (It's not like we're going to have to fix that in the next D8 minor, because there isn't a "next D8 minor".
  3. Removing the /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!

nitvirus’s picture

I like the 2nd approach better, we know we have put in a hardcoded url but there is no dependency on infra.

Matroskeen’s picture

Version: 8.9.x-dev » 9.0.x-dev

8.9.x receives only security updates, so there is nothing to do here.

@larowlan:

Yes please set it to fixed and change the version to the lowest version it went into

Matroskeen’s picture

Status: Patch (to be ported) » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.