WordPress.org

Make WordPress Core

Opened 5 weeks ago

Closed 4 weeks ago

#54357 closed enhancement (fixed)

Add help tabs in several screens to access their relative documentation

Reported by: jdy68 Owned by: audrasjb
Milestone: 5.9 Priority: normal
Severity: normal Version:
Component: Help/About Keywords: has-patch
Focuses: docs Cc:

Description

While checking the posts of the HelpHub documentation called via the tab Help in the various screens of the dashboard, I saw several things to improve.

1.In the Plugins Editor Screen, the documentation on the editor of plugin https://wordpress.org/support/article/plugins-editor-screen/ is well put in reference in tab Help, on the other hand it is not the case in the Apparence Editor Screen for the editor of theme https://wordpress.org/support/article/appearance-editor-screen/ which refers towards the documentation Edit files https://wordpress.org/support/article/editing-files/.

2.Help tabs are missing in several screens although a documentation post exists for these screens in HelpHub, we could add a Help tab and place there the link to the corresponding documentation, and a brief description of the screen's functionality as for the other screens in Overview. The help tabs and links to add are:

a.In the Privacy Settings Screen - the documentation Settings Privacy Screen https://wordpress.org/support/article/settings-privacy-screen/

b.In the Site Health Screen - the documentation Site Health Screen https://wordpress.org/support/article/site-health-screen/

c.In the Apparence Customize Screen - the documentation Appearance Customize Screen https://wordpress.org/support/article/appearance-customize-screen/

I propose to add the help tabs in the different screens and/or then place the links to the different documentations in them, as well as a small overview text for the new help tabs.
See screenshots of potential results:
privacy-screen-help-tab.png
site-health-screen-help-tab.png
customizer-add-link-to-help.png

Attachments (5)

privacy-screen-help-tab.png (23.0 KB) - added by jdy68 5 weeks ago.
site-health-screen-help-tab.png (28.8 KB) - added by jdy68 5 weeks ago.
customizer-add-link-to-help.png (11.4 KB) - added by jdy68 5 weeks ago.
54357.diff (4.9 KB) - added by jdy68 5 weeks ago.
proposed patch
54357.1.diff (4.9 KB) - added by jdy68 5 weeks ago.
corrected patch

Download all attachments as: .zip

Change History (15)

#1 @sabernhardt
5 weeks ago

  • Component changed from Administration to Help/About

@jdy68
5 weeks ago

proposed patch

#2 @audrasjb
5 weeks ago

  • Milestone changed from Awaiting Review to 5.9
  • Owner set to audrasjb
  • Status changed from new to reviewing

Thanks for opening this documentation ticket and patch. Moving for 5.9 consideration.

#3 @audrasjb
5 weeks ago

  • Focuses docs added

#4 @audrasjb
5 weeks ago

I didn't check the copy, but it looks like there are some coding standards issues to address Jenny :)

  • options-privacy.php

There's an unwanted trailing space in this string:
contains the Privacy Policy of your site. '
and in this one:
and to keep this information current and accurate. '

  • site-health.php

Same issue:
status of your installation. '
anything else that requires your attention. ') (on this one, you also need to add a space before the closing parenthesis)
Also, we need a trailing dot on this string:
to obtain support to solve a problem on your site'

This ticket was mentioned in Slack in #core by abhanonstopnews. View the logs.


5 weeks ago

@jdy68
5 weeks ago

corrected patch

#6 @audrasjb
5 weeks ago

Thanks for refreshing the patch. It looks good to me now 👍

This ticket was mentioned in Slack in #core by abhanonstopnews. View the logs.


4 weeks ago

#8 @webcommsat
4 weeks ago

  • Keywords needs-copy-review removed

We reviewed the copy in the bug scrub on the about/help page today. The revised wording is below.

Change from: “The Privacy screen allows you to create new page of Privacy Policy for your site or specify existing one which contains the Privacy Policy of your site”

to
"The Privacy screen lets you either build a new privacy-policy page or choose one you already have to show."

Thanks to @johnjamesjacoby who volunteered to do the patch/commit to make the deadline, and
all those who made suggestions for the text revision.

This ticket was mentioned in Slack in #core by abhanonstopnews. View the logs.


4 weeks ago

#10 @johnjamesjacoby
4 weeks ago

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

In 52053:

Admin/Help: add docs links to several screens.

This change intends to better guide users towards many of the useful resources available on WordPress.org.

  • Appearance/Customizer - Add link to Customizer docs.
  • Appearance/Editor - Improve link text & destination.
  • Privacy Settings - Link to Privacy Settings docs.
  • Site Health - Link to Site Health docs.

Props audrasjb, jdy68, webcommsat.

Fixes #54357.

Note: See TracTickets for help on using tickets.