Make WordPress Core

Opened 10 months ago

Closed 8 months ago

#58199 closed task (blessed) (fixed)

Add Help text for Rollback and Upgrade Issues

Reported by: costdev's profile costdev Owned by: audrasjb's profile audrasjb
Milestone: 6.3 Priority: normal
Severity: normal Version: 6.3
Component: Help/About Keywords: needs-docs has-patch has-copy-review commit
Focuses: Cc:

Description

When a site encounters an issue when upgrading Core, Plugins, Themes or Language Packs, it's not always clear what the user should do next.

With the pending addition of Rollback to Core during the 6.3 cycle, this provides an opportunity to add Help text for Rollback. Alongside this, we can also direct site owners to a HelpHub resource for general guidance when they encounter upgrade issues, and to the support forums for issues that need some investigation.

Attachments (3)

rollback-help.png (182.3 KB) - added by afragen 10 months ago.
58199-pr4381.patch (3.3 KB) - added by marybaum 8 months ago.
Patch after copy review
Capture d’écran 2023-07-09 à 16.39.11.png (351.9 KB) - added by audrasjb 8 months ago.
Way to go! 🤙

Download all attachments as: .zip

Change History (30)

This ticket was mentioned in PR #4381 on WordPress/wordpress-develop by @afragen.


10 months ago
#1

  • Keywords has-patch added

In preparation for Rollback PR 2225 being committed, @azaozz suggested the creation of a help/description of Rollback for users that might encounter a problem. This is an attempt to satisfy that documentation.

Trac ticket: https://core.trac.wordpress.org/ticket/58199

#2 @costdev
10 months ago

  • Keywords needs-testing added

This ticket was mentioned in Slack in #core-upgrade-install by afragen. View the logs.


10 months ago

This ticket was mentioned in Slack in #core-upgrade-install by afragen. View the logs.


10 months ago

#6 @afragen
10 months ago

  • Keywords needs-testing removed

#7 @costdev
10 months ago

Pinging @marybaum for copy review if you're available 🙂

This ticket was mentioned in Slack in #core-upgrade-install by afragen. View the logs.


10 months ago

#9 @kebbet
10 months ago

Might be relevant here too: #58282

@kebbet commented on PR #4381:


10 months ago
#10

With https://core.trac.wordpress.org/ticket/58282 (and https://core.trac.wordpress.org/changeset/55750 in trunk) I will make some suggestions to the help tab copy. Please feel free to rework and comment.

#11 @oglekler
9 months ago

@marybaum please look at this PR, we have Beta 1 in 8 days and because this is an enhancement, it needs to be in trunk before Beta. Thanks 🙏

This ticket was mentioned in PR #4688 on WordPress/wordpress-develop by @kebbet.


8 months ago
#12

This PR is extending #4381

Changes are new strings.

  • $rollback_help = '<p>' . __( 'This feature will create a temporary backup of a plugin or theme before it is upgraded. This backup is used to restore the plugin or theme back to its previous state if there is an error during the update process.' ) . '</p>';
  • 'title' => __( 'Plugin & Theme restoration' ),

https://core.trac.wordpress.org/ticket/58199

@kebbet commented on PR #4688:


8 months ago
#13

Screenshot of current PR
https://i0.wp.com/github.com/WordPress/wordpress-develop/assets/11491369/dafbe83b-0cea-4cd9-b5a2-86d000ce357a

@marybaum
8 months ago

Patch after copy review

#14 @marybaum
8 months ago

  • Keywords has-copy-review added; needs-copy-review removed

Just uploaded a patch with edited copy. Feel free to do your damnedest!

#15 follow-up: @kebbet
8 months ago

Rollback as a term is hard to translate for many locales and has been replaced in core. Could we avoid new introduction of the term in this ticket?

#16 @audrasjb
8 months ago

  • Type changed from enhancement to task (blessed)

Converting to a task as this can ship after beta 1 is released.

#17 in reply to: ↑ 15 ; follow-up: @afragen
8 months ago

Replying to kebbet:

Rollback as a term is hard to translate for many locales and has been replaced in core. Could we avoid new introduction of the term in this ticket?

Can you reference a changeset where this has been done?

#18 in reply to: ↑ 17 @kebbet
8 months ago

Replying to afragen:

Replying to kebbet:

Rollback as a term is hard to translate for many locales and has been replaced in core. Could we avoid new introduction of the term in this ticket?

Can you reference a changeset where this has been done?

#58282 [55750]

#19 @afragen
8 months ago

Thanks @kebbet. I was looking to see the language change.

#21 @audrasjb
8 months ago

  • Owner set to audrasjb
  • Status changed from assigned to reviewing

This looks all good to me.
Self assigning for final testing then commit.

#22 @audrasjb
8 months ago

  • Keywords commit added

#23 @audrasjb
8 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 56171:

Help/About: Add Help text for Rollback feature.

This changeset adds a new Help text for Rollback feature in the WordPress Updates screen. Also adds a link to the "Common Errors" HelpHub documentation page.

Follow-up to [51857].

Props costdev, afragen, audrasjb, kebbet, marybaum.
Fixes #58199.

#25 @tobifjellner
8 months ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

@audrasjb
Could you rephrase a bit? The support forums don't have tickets, but "topics".

Ref:
On systems with fewer resources, this may lead to server timeouts or resource limits being reached. If you encounter an issue during the update process, please create a support forum ticket and reference <strong>Rollback</strong> in the issue title.

This ticket was mentioned in Slack in #forums by tobifjellner. View the logs.


8 months ago

#27 @azaozz
8 months ago

  • Resolution set to fixed
  • Status changed from reopened to closed

In 56237:

Help/About: Fix typo in [56171]: support forum "topic", not "ticket".

Props: tobifjellner.
Fixes: #58199.

Note: See TracTickets for help on using tickets.