Problem/Motivation
Several links go to documentation for Drupal 7 instead of Drupal 8: for example, https://www.drupal.org/docs/7/install instead of https://www.drupal.org/docs/8/install.
Some links are redirected, and most have URL aliases as well as /node/...
versions. The following table includes such variants.
Proposed resolution
Change the following links:
The following searches should show which files contain any of these links:
$ grep -irl "getting-started/install" core
core/tests/Drupal/FunctionalTests/Installer/InstallerTranslationTest.php
core/lib/Drupal/Core/Installer/Form/SiteSettingsForm.php
$ grep -irl "docs/7/install" core
$ grep -irl "node/2764151" core
$ grep -irl "documentation/install" core
core/INSTALL.txt
core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php
$ grep -irl "extend/overview" core
$ grep -irl "node/176043" core
$ grep -irl "docs/7/multisite" core
$ grep -irl "node/251040" core
$ grep -irl "getting-started/clean-urls" core
core/INSTALL.txt
$ grep -irl "documentation/multilingual" core
core/INSTALL.txt
$ grep -irl "node/15365" core
core/modules/system/system.install
$ grep -irl "docs/7/system-requirements/" core
core/modules/system/system.install
As noted in #37, we should not update this reference, so we should get the same results before and after applying the patch:
$ grep -irB 1 "docs/7/" core
core/themes/seven/README.txt-To read more about the Seven theme's origins (in Drupal 7) please see:
core/themes/seven/README.txt:https://www.drupal.org/docs/7/core/themes/seven
This issue is just about updating the links. Some of them are explicit strings, like <a href="https://www.drupal.org/getting-started/install">installation handbook</a>
, and others are arguments to the t()
function, like t('... <a href=":link">Enable clean URLs</a>', [':link' => 'http://drupal.org/node/15365'])
. Being more consistent is out of scope for this issue, and may be a mistake. See Comment #22 below.
It is OK to expand the scope of this issue if you find addtional links that need to be updated. Just be sure to update the table and search results above. Let's not try to update every link that needs to be updated as part of this issue.
Remaining tasks
- Reroll the patch. See Comment #44 and Contributor task: Re-roll a Drupal core patch or Rerolling patches.
User interface changes
String changes
API changes
None
Data model changes
None
Comment | File | Size | Author |
---|---|---|---|
#47 | interdiff-45-47.txt | 1.27 KB | imalabya |
#47 | urls-point-d7-docs-pages-2830239-47.patch | 8.1 KB | imalabya |
#45 | urls-point-d7-docs-pages-2830239-45.patch | 8.38 KB | imalabya |
#39 | interdiff_36-39.txt | 511 bytes | spitzialist |
#39 | urls-point-d7-docs-pages-2830239-39.patch | 8.08 KB | spitzialist |
Comments
Comment #2
cebasqueira CreditAttribution: cebasqueira at CI&T commentedComment #3
cebasqueira CreditAttribution: cebasqueira at CI&T commentedComment #4
faline CreditAttribution: faline at CI&T commentedThis is ok for me! The patch applies and also the urls are right.
Comment #5
cilefen CreditAttribution: cilefen commentedWe will close #2830260: The update modules handbook help link points to the D7 page and have one issue (this one) to fix all the bad handbook links.
Comment #6
cebasqueira CreditAttribution: cebasqueira at CI&T commentedComment #7
cebasqueira CreditAttribution: cebasqueira at CI&T commented@cilefen patch updated with #2830260: The update modules handbook help link points to the D7 .
Comment #8
faline CreditAttribution: faline at CI&T commented@cebasqueira there is one more that points to wrong url
I'm not sure if this one should also be changed.
Comment #9
monta CreditAttribution: monta commented@faline
This should be changed also
Comment #10
cebasqueira CreditAttribution: cebasqueira at CI&T commentedPatch updated!
Comment #11
faline CreditAttribution: faline at CI&T commentedFor me it is ok now
Comment #12
cilefen CreditAttribution: cilefen commentedThis needs a title and summary update to reflect the current scope.
Comment #13
monta CreditAttribution: monta commentedPatch works fine
Comment #14
faline CreditAttribution: faline at CI&T commentedComment #15
faline CreditAttribution: faline at CI&T commented@cilefen I've update the summary and title, is this ok now?
thank you
Comment #16
faline CreditAttribution: faline at CI&T commented@cilefen I've update the summary and title, is this ok now?
thank you
Comment #17
monta CreditAttribution: monta commented@faline it's OK
Comment #18
faline CreditAttribution: faline at CI&T commentedSo as the patch works fine, I'm put as RTBC
Comment #19
Dinesh18 CreditAttribution: Dinesh18 as a volunteer and at TATA Consultancy Services for Pfizer, Inc. commentedpatch worked for me as well.
Comment #21
cebasqueira CreditAttribution: cebasqueira at CI&T commentedComment #22
alexpottWe can only fix this in 8.3.0 because we shouldn't be changing translatable strings in patch releases. For example:
This will break all translations. We've started to put links in urls so people can internationalise the links and point to translated help. So this is correct rather the other links where we use a placeholder. Fixing such text is out-of-scope here though - please file a follow up it'd be good to get that done before 8.3.0 to minimise string change though :)
Comment #23
alexpottComment #24
alexpottComment #25
alexpottAfter applying the patch - looks like we should fix these here too - to be consistent everywhere:
https://www.drupal.org/getting-started/clean-urls => https://www.drupal.org/docs/8/clean-urls-in-drupal-8
https://www.drupal.org/documentation/install/download#git => this is about composer... I guess https://www.drupal.org/docs/8/install/before-installation will take you to the right places... but maybe we need a nice URL for https://www.drupal.org/node/2404989
https://www.drupal.org/documentation/install/multi-site => https://www.drupal.org/docs/8/multisite-drupal
Comment #26
cilefen CreditAttribution: cilefen commentedSee #12 as the issue changes.
Comment #27
monta CreditAttribution: monta commentedI've updated the title again
Comment #32
benjifisherI ran into one of these links when I tried installing Drupal with
.htaccess
missing. The warning message in the installer directed me to http://drupal.org/node/15365, the unaliased (and HTTP, insecure) URL for https://www.drupal.org/docs/7/configuring-clean-urls/enable-clean-urls. The link https://www.drupal.org/getting-started/clean-urls (Comment #25 above) redirects to the same page.In addition to the searches in #25,
I will update the issue summary.
Comment #33
benjifisherNow that I have updated the summary, I think we can call this a Novice task, so I am adding that tag. Let's try to get this done!
As noted in #22, we cannot update translatable strings in a patch release. At this point, that means the earliest we can do this will be in Drupal 8.7.0.
Comment #34
th_tushar CreditAttribution: th_tushar as a volunteer commentedAttached patch updates URLs mentioned in issue description.
Comment #35
benjifisher@th_tushar: Thanks for working on this! Since the issue is marked "Novice", and you are a Technical Lead at your company, with 16 people listing you as a mentor on d.o, you could have coached someone else to work on this.
Somehow, your patch was mis-named: it ends in "-36.patch" but is attached to Comment #34. We do not have to fix it, but I want to mention it to avoid confusion.
Please also attach an interdiff, comparing your patch to the previous one. See https://www.drupal.org/documentation/git/interdiff if you need instructions.
I see that you noticed another link that needs to be updated: https://www.drupal.org/documentation/multilingual in INSTALL.txt. Good catch, but please note what the issue summary says about expanding scope. For documentation purposes, please add that link, the one it redirects to, and the unaliased path to the table in the issue description, and add corresponding
grep
searches (with the results on an unpatched version of 8.7.x).Comment #36
spitzialist CreditAttribution: spitzialist at Unic commentedUpdated issue description (table and grep statement with results) as proposed in #35.
Comment #37
spitzialist CreditAttribution: spitzialist as a volunteer commentedWanted to create interdiff but patch "mistake_in_the_url_of-2830239-10.patch" is not applicable to current branch of 8.7.x.
Also online tools to create interdiff did not work.
I would propose to test the current patch without an interdiff.
Comment #38
spitzialist CreditAttribution: spitzialist as a volunteer commentedFound another comment with mention of Drupal 7 docs:
I've updated the issue summary and will add the lines to the patch.
Comment #39
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedAdded new patch and interdiff for link change mentioned in comment #38.
Additionally, another mention of Drupal 7 docs was found but this one is correct as it specifically mentions Drupal 7:
This should stay unchanged.
Comment #40
benjifisherI noticed a related issue: #2855175: [META] Many documentation / handbook URLs redirect to D7 content. Curiously, it looks as though there is no overlap between the links found there and the ones found in this issue. Maybe I have to read it more closely.
@spitzialist, good point about the link for the history of the Seven theme. I added a note to the issue summary to check for this.
To review the patch, I did the following:
grep
commands from the issue summary, and check that the result is similar to what it shows in the summary. (I updated the summary where it was missing a couple of matches.)grep
commands again. Check that nothing is found, except as noted above.It all looks good to me, so I am marking the issue RTBC. I am also removing the Novice tag, since the novice tasks have already been done.
Comment #41
catchSince we're changing the string here, should we consider making it use
<a href=":link"
so that the next time the URL is updated, the translation won't need to?Comment #42
benjifisher@catch: I think that is the same change that @alexpott discussed in Comment #22:
Based on that, I added this when I updated the issue summary:
Did I over-generalize?
I have not re-reviewed, but I think I have answered the question in #41, so I will move this issue back to RTBC.
Comment #43
catch@benjifisher thanks that makes sense - however the patch also needs a re-roll.
Comment #44
benjifisherThis looks like a pretty easy reroll, so I will add the Novice label and update the issue summary.
The conflict comes from #2856362: Drupal install fail on Percona XtraDB Cluster 5.7 (pxc_strict_mode enforced).
Comment #45
imalabyaAdded a rerolled patch.
Comment #47
imalabyaAdding a new patch.
Comment #48
benjifisher@imalabya:
Since you are an experienced contributor, with several people who list you as a mentor, maybe next time you come across a Novice issue you can help someone less experienced to fix it.
Thanks for the updated patch. The only differences between your patch in #47 and the patch in #39 are
Based on my previous review, and the comparison I made when I added #45, I can move this issue back to RTBC.
Comment #49
benjifisherComment #50
catchCommitted b5ff72a and pushed to 8.7.x. Thanks!
Comment #52
catchComment #53
benjifisherThanks to all who helped on this issue! If you want to work on something similar, but more ambitious, have a look at #2855175: [META] Many documentation / handbook URLs redirect to D7 content.
Comment #55
quietone CreditAttribution: quietone as a volunteer commentedThe proposed resolution states that
http://drupal.org/node/15365
is to be changed tohttps://www.drupal.org/docs/8/clean-urls-in-drupal-8
but that did not happen. The link was changed but not the scheme.There is an existing issue that identified the scheme, #3002983: Convert http links to https at system module