Problem/Motivation
The original report of this issue mentioned that all links referencing upgrade are pointing to Drupal 7 documentation.
It seems it's no longer the case, but some of them are still not correct though.
Here is a list of links that probably should be changed:
1) https://git.drupalcode.org/project/drupal/-/blob/9.2.x/core/includes/upd...
// Display a requirements error if the user somehow has a schema version
// from the previous Drupal major version.
if ($schema_version < \Drupal::CORE_MINIMUM_SCHEMA_VERSION) {
$ret[$module]['warning'] = '<em>' . $module . '</em> module cannot be updated. Its schema version is ' . $schema_version . ', which is from an earlier major release of Drupal. You will need to <a href="https://www.drupal.org/node/2127611">migrate the data for this module</a> instead.';
continue;
}
Current link points to https://www.drupal.org/node/2127611, which is Migrate API overview. I think it might be confusing for someone who is not familiar with the migration process yet. Probably a link to Upgrading Drupal (https://www.drupal.org/docs/upgrading-drupal) is a better fit.
xjm asked for this change in 2168011#138
2) https://git.drupalcode.org/project/drupal/-/blob/9.2.x/core/modules/syst...
$build['info_header'] = [
'#markup' => '<p>' . $this->t('Use this utility to update your database whenever a new release of Drupal or a module is installed.') . '</p><p>' . $this->t('For more detailed information, see the <a href="https://www.drupal.org/upgrade">upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.') . '</p>',
];
Current link points to https://www.drupal.org/upgrade, which is a mix of Update and Upgrade processes and is more about Drupal 7.
Considering this is about Drupal update (not upgrade), the link should be pointing to: https://www.drupal.org/docs/updating-drupal
3) https://git.drupalcode.org/project/drupal/-/blob/9.2.x/core/modules/upda...
return [
'no-core' => t('Automatic updating of Drupal core is not supported. See the <a href=":upgrade-guide">upgrade guide</a> for information on how to update Drupal core manually.', [':upgrade-guide' => 'https://www.drupal.org/upgrade']),
];
This link should be also about the update process, and especially about updating Drupal core. The recommended URL is https://www.drupal.org/docs/updating-drupal
Proposed resolution
Update mentioned links with provided URLs. In some cases, link titles should be changed as well.
Remaining tasks
Attach a patch, review, commit.
User interface changes
Some update/upgrade links are changed for more appropriate versions.
API changes
-
Data model changes
-
Release notes snippet
-
Comment | File | Size | Author |
---|---|---|---|
#21 | 2830352-21.patch | 3.37 KB | quietone |
#19 | 2830352-19.patch | 3.37 KB | quietone |
#19 | interdiff-17-19.txt | 1.05 KB | quietone |
#17 | 2830352-17.patch | 2.33 KB | quietone |
#17 | interdiff-13-17.txt | 2.34 KB | quietone |
Comments
Comment #2
cebasqueira CreditAttribution: cebasqueira at CI&T commentedComment #3
faline CreditAttribution: faline at CI&T commentedMaybe the follow links should be changed also:
core/modules/migrate_drupal_ui/migrate_drupal_ui.module
core/modules/migrate_drupal_ui/src/Form/MigrateUpgradeForm.php
drupal/core/UPDATE.txt
What dou you think @cebasqueira?
Comment #4
cebasqueira CreditAttribution: cebasqueira at CI&T commented@faline, the migrate pages are correct and backing-up-the-db documentation is not disponible today for Drupal 8 documentation!
Comment #5
faline CreditAttribution: faline at CI&T commentedSo for other links this issue is ok.
Comment #6
xjmThis patch is not correct. The first line of https://www.drupal.org/docs/8/upgrade says:
At least some of these links are supposed to tell the user how to perform minor updates using
update.php
, which is not the same thing.Comment #13
quietone CreditAttribution: quietone as a volunteer commentedWow, there are still D7 links around.
Updated the patch. I don't see the need to run tests until there is agreement on the text and link changes.
Comment #14
Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commentedApplied patch #13 and the documentation links are changed based on relevance.
RTBC +1
Comment #15
MatroskeenI accidentally came across this issue and decided to do a review 😊
I have updated the issue summary, were added my suggestions for new links.
Comment #16
MatroskeenIt seems #2855175: [META] Many documentation / handbook URLs redirect to D7 content is a good meta for this one.
Comment #17
quietone CreditAttribution: quietone as a volunteer commentedThe suggestion for 1) is a page that has information for Upgrading Drupal 7, so I think we need to find a better page. There is nothing there for updating a module in Drupal 9.
I did the other two. Not sure the interdiff is useful but added it anyway.
@Abhijith S, Thank you for your interest in this issue. Adding screenshots that a patch applied does not advance the issue, that information is already available from the testing results. The contributor guide on Drupal.org has information about how to contribute, particularly the process to Review a patch or merge request. There are also clear guidelines for How is credit granted for Drupal core issues..
Edit: s/Add/Adding/
Comment #18
quietone CreditAttribution: quietone as a volunteer commentedComment #19
quietone CreditAttribution: quietone as a volunteer commentedMatroskeen pinged me in #bugsmash about this, and on rereading the first suggested change, I find that I didn't read it properly early. Adding that change now.
Comment #20
MatroskeenFor the 1) link I think the title should be "Upgrading Drupal guide" because the page title is "Upgrading Drupal".
Otherwise, it looks good, thanks!
Comment #21
quietone CreditAttribution: quietone as a volunteer commentedSorry about that. Silly mistake.
Made the requested change and also changed 2 and 3 so the case of the text matches the title on the page.
No interdiff because all three lines were changed.
Comment #22
MatroskeenThe last patch addresses the initial report and aligns with comment #6 from @xjm.
It also looks good to me, so I will gently try moving it to RTBC 😇
@quietone Thanks!
Comment #23
MatroskeenIt occurred to me that we're changing a translatable text, which might affect the existing translations. What is the proper way to deal with it?
edit:
I asked in Slack, and received the following answer from @jhodgdon:
Leaving it RTBC :)
Comment #24
catchCommitted 3f8a67e and pushed to 9.3.x. Thanks!