Problem/Motivation

UPDATE.txt and UPGRADE.txt currently have to deal with:

1. Migrations from Drupal 6 and Drupal 7.
2. Updates between Drupal 8 or 9 minor and patch releases.
3. Updates from Drupal 8 to Drupal 9, and eventually Drupal 10.

They are also outdated at the moment, per this critical issue #3090183: UPGRADE.txt only mentions migrating from Drupal 6 and 7, UPDATE.txt only mentions 8-8 updates.

Proposed resolution

Rather than 'fix' them, add an explicit link to https://www.drupal.org/docs/9/how-to-prepare-your-drupal-7-or-8-site-for... from README.txt. This documentation is updated more often, and is more comprehensive, than .txt files in our code base.

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

catch created an issue. See original summary.

quietone’s picture

Good idea. +1

catch’s picture

Priority: Normal » Critical
Issue tags: +beta target

Bumping priority temporarily since this would make the other issue non-critical if we did it.

bnjmnm’s picture

Status: Active » Needs review
FileSize
11.34 KB

This updates UPDATE.txt to refer the user to drupal.org documentation for each of the scenarios in the issue summary.

Webbeh’s picture

FileSize
2.16 KB
11.38 KB

Per #4, should the URLs be converted to their node IDs for simplicity and line lengths (and perhaps any URL path alias changes)? I went ahead and addressed this, as some URLs exceeded the 80 character limit.

I also did a few copy changes across the document for consistency.

I standardized headers and spacing, both in bulleted lists, headers, and sections.

I also separated out the composer and point-release combined copy and re-instantiated the composer header, as the pairing of the two sections read really awkward to me. I expanded the point releases to define what each release-type was, for clarity's sakes.

For review with interdiff.

catch’s picture

Status: Needs review » Needs work

We should link to the aliases, they're more likely to be redirected if the location on d.o changes.

The patch should make a similar change to UPGRADE.txt too.

Webbeh’s picture

FileSize
11.54 KB
724 bytes

We should link to the aliases, they're more likely to be redirected if the location on d.o changes.

Got it. Re-rolled with aliases restored.

The patch should make a similar change to UPGRADE.txt too.

Marking this as still 'Needs Work' for someone else if they have some availability to do.

bnjmnm’s picture

Status: Needs work » Needs review

Thanks for jumping in on this @Webbeh!

Re #6

The patch should make a similar change to UPGRADE.txt too.

There is no UPGRADE.txt in HEAD. That is a file added in the patch for #3090183: UPGRADE.txt only mentions migrating from Drupal 6 and 7, UPDATE.txt only mentions 8-8 updates, but doesn't seem necessary here as UPDATE.txt covers all of the use cases in a concise enough manner to not necessitate a second file.

catch’s picture

Title: Replace UPDATE.txt and UPGRADE.txt with a link to d.o documentation » Replace UPDATE.txt with links to d.o documentation
Status: Needs review » Reviewed & tested by the community

There is no UPGRADE.txt in HEAD

That's a very good point...

These changes look great to me. They give a rough overview of the three types of upgrades, but otherwise send you off to d.o for a proper write up. We can always follow-up again with more improvements but much better than outdated/wrong information.

xjm’s picture

Status: Reviewed & tested by the community » Needs work

Thanks for working on this. Massively in favor of reducing this unmaintainable text to links to the handbook.

A few things I think we need to fix:

  1. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
    +This document provides links to resources on how to update or upgrade your
    

    "Update or upgrade" here sounds redundant. We should abandon the useless distinction between "update" and "upgrade". I'd say "update or migrate".

  2. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
     MINOR AND PATCH VERSION UPDATES
    ...
    +Minor and patch versions are updates such as:
    + * Patch releases (e.g. 9.1.2 to 9.1.3)
    + * Scheduled minor releases (e.g 9.3.5 to 9.4.0)
    

    So... right now this section is not useful. It's not giving any instrutions.

    We should at least add a paragraph something like:

    Minor and patch updates are done either with Composer or manually depending on how the site was installed. Refer to the sections below on updating with Composer or updating manually for tarball/zip installations.

    That could use wordsmithing but something along those lines.
     

  3. We're also actually totally missing a section on upgrading with not-Composer. We should have a similar stub for "Upgrading manually (for tarball or zip installations" that links those docs directly.

  4. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
    -3. Determine if your project is managed by Composer.
    -
    -   On a typical Unix/Linux command line, this can be determined by running the
    -   following command (replace /PATH/TO/composer with the appropriate location
    -   for your system):
     
    -     /PATH/TO/composer info drupal/core
    

    This is useful information and helps the user pick which of composer vs. manual updates they should do. I'd include it.

  5. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
    + * Beta to final releases (e.g. 9.1.0-beta to 9.1.0)
    

    9.1.0-beta is not a tag we'd have. One could say 9.1.0-beta2.

  6. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
    +  composer:
    

    "Composer" should be capitalized.

  7. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
    + * First, the Drupal 8 site must be prepared for Drupal 9:
    +   https://www.drupal.org/docs/9/how-to-prepare-your-drupal-7-or-8-site-for-drupal-9/upgrading-a-drupal-8-site-to-drupal-9
    + * Second, the Drupal 8 codebase must be updated to Drupal 9:
    +   https://www.drupal.org/docs/8/upgrade/upgrading-between-drupal-8-major-versions-eg-from-drupal-8-to-drupal-9
    + * Finally, navigate to /update.php to initiate the upgrade process.
    

    Rather than saying "First", "second", etc. let's just make it a numbered list?

    Also I'd add a blank line after each bullet for readability.

  8. +++ b/core/UPDATE.txt
    @@ -1,242 +1,42 @@
    +Refer to the Migrate guide for upgrade process details:
    

    I would say "for details on this process" to make it clear it's related to the paragraph above, and because normal people don't know or understand our distinction between "upgrade" and "update".

Webbeh’s picture

Status: Needs work » Needs review
FileSize
12.57 KB
3.62 KB

Each point in comment #10 was applied - interdiff and patch attached.

"Update or upgrade" here sounds redundant. We should abandon the useless distinction between "update" and "upgrade". I'd say "update or migrate".

Of particular note is the move from 'upgrade and update' to 'update' - I've applied this across the TXT file, with the only two exclusions being URLs that still have the string present.

We're also actually totally missing a section on upgrading with not-Composer. We should have a similar stub for "Upgrading manually (for tarball or zip installations" that links those docs directly.

This was applied as a new section mirroring the update text for Composer, but linking to https://www.drupal.org/docs/user_guide/en/security-update-core.html . Is there a better URL or guide this should link to, instead?

xjm’s picture

Thanks @Webbeh!

One thing:

+++ b/core/UPDATE.txt
@@ -1,42 +1,77 @@
+   https://www.drupal.org/docs/user_guide/en/security-update-core.html

Interesting; we have duplicate documentation here. The content looks correct, but I think probably we want https://www.drupal.org/docs/8/update/update-core-manually which is a child page of the link in the release notes and a sibling to the Composer section.

Webbeh’s picture

Agreed on #12, new URL applied replacing the URL. Interdiff and patch attached.

daffie’s picture

Status: Needs review » Reviewed & tested by the community

All points of @xjm are addressed.
The patch looks good.
Tested all links in Update.txt and they all work.
Back to RTBC.

  • xjm committed 2c371ef on 8.8.x
    Issue #3136302 by Webbeh, bnjmnm, catch, xjm: Replace UPDATE.txt with...
  • xjm committed dbb4791 on 8.9.x
    Issue #3136302 by Webbeh, bnjmnm, catch, xjm: Replace UPDATE.txt with...
  • xjm committed 59f9fda on 9.0.x
    Issue #3136302 by Webbeh, bnjmnm, catch, xjm: Replace UPDATE.txt with...
  • xjm committed 7546ecb on 9.1.x
    Issue #3136302 by Webbeh, bnjmnm, catch, xjm: Replace UPDATE.txt with...
xjm’s picture

Version: 9.0.x-dev » 8.8.x-dev
Status: Reviewed & tested by the community » Fixed

OK, this looks great now. Committed to 9.1.x, and cherry-picked back through 8.8.x as a patch-eligible documentation improvement. Thanks!

Status: Fixed » Closed (fixed)

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

quietone’s picture