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
Comment | File | Size | Author |
---|---|---|---|
#13 | interdiff-3136302-11-13.txt | 439 bytes | Webbeh |
#13 | 3136302-13.patch | 12.56 KB | Webbeh |
#11 | interdiff-3136302-7-11.txt | 3.62 KB | Webbeh |
#11 | 3136302-11.patch | 12.57 KB | Webbeh |
#7 | 3136302-7.patch | 11.54 KB | Webbeh |
Comments
Comment #2
quietone CreditAttribution: quietone as a volunteer commentedGood idea. +1
Comment #3
catchBumping priority temporarily since this would make the other issue non-critical if we did it.
Comment #4
bnjmnmThis updates UPDATE.txt to refer the user to drupal.org documentation for each of the scenarios in the issue summary.
Comment #5
WebbehPer #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.
Comment #6
catchWe 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.
Comment #7
WebbehGot it. Re-rolled with aliases restored.
Marking this as still 'Needs Work' for someone else if they have some availability to do.
Comment #8
bnjmnmThanks for jumping in on this @Webbeh!
Re #6
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.
Comment #9
catchThat'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.
Comment #10
xjmThanks 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:
"Update or upgrade" here sounds redundant. We should abandon the useless distinction between "update" and "upgrade". I'd say "update or migrate".
So... right now this section is not useful. It's not giving any instrutions.
We should at least add a paragraph something like:
That could use wordsmithing but something along those lines.
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 is useful information and helps the user pick which of composer vs. manual updates they should do. I'd include it.
9.1.0-beta is not a tag we'd have. One could say 9.1.0-beta2.
"Composer" should be capitalized.
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.
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".
Comment #11
WebbehEach point in comment #10 was applied - interdiff and patch attached.
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.
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?
Comment #12
xjmThanks @Webbeh!
One thing:
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.
Comment #13
WebbehAgreed on #12, new URL applied replacing the URL. Interdiff and patch attached.
Comment #14
daffie CreditAttribution: daffie commentedAll points of @xjm are addressed.
The patch looks good.
Tested all links in Update.txt and they all work.
Back to RTBC.
Comment #16
xjmOK, this looks great now. Committed to 9.1.x, and cherry-picked back through 8.8.x as a patch-eligible documentation improvement. Thanks!
Comment #18
quietone CreditAttribution: quietone as a volunteer commentedClosed #3090183: UPGRADE.txt only mentions migrating from Drupal 6 and 7, UPDATE.txt only mentions 8-8 updates as a duplicate.