Problem/Motivation

Drupal 8.1.0 comes with the first upgrade UI solution. It is critically important to have documentation that clearly explains what each process is for and how to use them. Drupal's UPGRADE.txt is misleading in its name and then its mixed use of update and upgrade which makes it hard to get to know the concepts clearly.

Proposed resolution

- Rename the file to UPDATE.txt, its about updates.
- Modify where it says upgrade and means update to update
- Modify where it means both upgrade and update to mention both
- Modify intro where it says Migrate Upgrade is a contributed module. It is a core module and has a different name.

Remaining tasks

Get it in :)

User interface changes

None.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#14 drupal_8_upgrade_txt_is-2701027-14.patch584 bytessharique
#2 2701027.patch2.48 KBgábor hojtsy

Comments

Gábor Hojtsy created an issue. See original summary.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
StatusFileSize
new 2701027.patch2.48 KB
catch’s picture

catch
he/him
Primary language English
commented
Issue tags: +rc target
catch’s picture

catch
he/him
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Those changes look great actually, so moving to RTBC.

swentel’s picture

swentel commented 
+++ b/core/UPDATE.txt
@@ -38,19 +38,19 @@ First steps and definitions:
+More in-depth information on updating and upgrading can be found at
 https://www.drupal.org/upgrade

should there be an www.drupal.org/update url then ? Seems confusing too no ?

- edit - actually, nevermind, didn't read the full sentence..

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented

@swentel: yeah the /upgrade URL on d.o is a landing page for BOTH updates and upgrades. It could be /update-or-upgrade or something like that but we don't really do those dash patterned paths elsewhere. Also needs a d.o redirect set up then at least for URL redirection.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

The improvements here are valuable and given the push on migrate and the fact this is the first minor release important to have. I think that we might want to create an UPGRADE.TXT so that this file doesn't have to so much about upgrading in the first paragraphs. But we can explore improvements later. Let's just have it being correct to start with.

Committed 11f8979 and pushed to 8.1.x and 8.2.x. Thanks!

  • alexpott committed e4daf32 on 8.2.x 
    Issue #2701027 by Gábor Hojtsy: Drupal 8 UPGRADE.txt is misleading in...

  • alexpott committed 11f8979 on 8.1.x 
    Issue #2701027 by Gábor Hojtsy: Drupal 8 UPGRADE.txt is misleading in...
gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented

Yay, thanks!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Oh, man. Did anyone bother to check how many links/references there were to this file, on drupal.org and in other .txt files in Core??????????????????????????????

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Or perhaps to wait a few hours with this at RTBC so that the documentation maintainer could notice it and bring up this concern?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Fixed » Needs work

At a minimum, the top-level README.txt needs a fix for this change.

sharique’s picture

sharique commented
Status: Needs work » Needs review
StatusFileSize
new drupal_8_upgrade_txt_is-2701027-14.patch584 bytes

Patch for updating README.txt file.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented

@jhodgdon: the references on drupal.org are editable (and should be edited) while a tagged Drupal release is not modifiable after the fact. The references on drupal.org I found were for the Drupal 7 UPGRADE.txt which the patch did not change. Eg. https://www.drupal.org/node/1223018 used to refer to the file but does not do so anymore.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Priority: Major » Normal
Status: Needs review » Reviewed & tested by the community
Issue tags: -rc target

@jhodgdon: I also don't think most committers are keen to multi-commit from an issue (given that the title, summary and tagging of the issue would need to be all changed now to reflect what this issue is about now), but we can always try.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed da742ad and pushed to 8.1.x and 8.2.x. Thanks!

@Gábor Hojtsy yeah not keen on multiple commits per issue - but in the interests of getting this done just doing it.

  • alexpott committed d10dea1 on 8.2.x 
    Issue #2701027 by Gábor Hojtsy, Sharique, jhodgdon: Drupal 8 UPGRADE.txt...

  • alexpott committed da742ad on 8.1.x 
    Issue #2701027 by Gábor Hojtsy, Sharique, jhodgdon: Drupal 8 UPGRADE.txt...
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented

Also in #7 I talked about the possibility of re-introducing UPGRADE.txt to explain migrations. @xjm made a good point that this probably should just be called MIGRATE.txt.

xjm’s picture

xjm
she/her
Primary language English
commented

Posted a small novice followup for the followup: #2707095: Add back serial comma in README.txt

Status: Fixed » Closed (fixed)

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