Opened 3 years ago

Closed 2 years ago

#15314 closed task (blessed) (fixed)

Contextual Help for Network Admin

Reported by: PeteMall Owned by: andrea_r
Priority: normal Milestone: 3.1
Component: Network Admin Version: 3.1
Severity: normal Keywords: has-patch i18n-change
Cc: andrea_r, john@…, heymrpro@…

Description (last modified by PeteMall)

This is the master ticket for adding contextual help for the network admin screens. See #14435

The following screens are missing contextual help:

  • Network Dashboard
  • Sites
    • Add New
    • Edit Site
      • Info
      • Options
      • Users
      • Themes
  • Users
    • Add New

More to come...

Attachments (10)

15314.diff (13.3 KB) - added by andrea_r 3 years ago.
15314.2.patch (1.5 KB) - added by vegasgeek 2 years ago.
Update to site-themes.php
15314.3.patch (1.3 KB) - added by vegasgeek 2 years ago.
Update to site-options.php
15314.site-themes.diff (1.5 KB) - added by nacin 2 years ago.
Diff off trunk from vegasgeek
15314.site-options.diff (2.8 KB) - added by nacin 2 years ago.
Diff off trunk from vegasgeek
15314.5.diff (2.2 KB) - added by andrea_r 2 years ago.
15314.6.diff (2.2 KB) - added by andrea_r 2 years ago.
15314.7.patch (5.3 KB) - added by SergeyBiryukov 2 years ago.
Fixed one misprint, removed trailing whitespace.
15314.8.patch (1.2 KB) - added by SergeyBiryukov 2 years ago.
Improved wording.
other3tabs.patch (3.5 KB) - added by dougwrites 2 years ago.
Option for if we want all the tabs to say, "see the other tabs"

Download all attachments as: .zip

Change History (53)

  • Type changed from defect (bug) to task (blessed)
  • Owner set to andrea_r
  • Status changed from new to assigned
  • Milestone changed from Awaiting Review to 3.1
  • Cc andrea_r added
  • Description modified (diff)

Related: #15346, #15376

  • Keywords has-patch added; needs-patch removed

First pass.

Update to site-themes.php

  • Cc john@… added

Update to site-options.php

comment:9   zeo2 years ago

Related to #15346, use "Documentation on X" instead of "X Documentation".

  • Cc heymrpro@… added

(In [16981]) Network Admin contextual help. props andrea_r (!), see #15314.

nacin2 years ago

Diff off trunk from vegasgeek

nacin2 years ago

Diff off trunk from vegasgeek

(In [16982]) Network admin contextual help edits. props vegasgeek, see #15314.

(In [16983]) Move to 'Documentation on XY' in the network admin. see #15314.

(In [16984]) Network Admin: Rename Options to Settings. Kick the tab to the end as well. see #15314.

(In [16985]) A few more s/site-options/site-settings/. see #15314.

  • Keywords needs-patch added; has-patch removed

Kicking this back to Andrea, so text, terminology, and Codex links can be updated as appropriate, as a lot has changed.

  • Component changed from Multisite to Network Admin
  • Keywords has-patch i18n-change added; needs-patch removed

Last minor changes. Everything looks good.

not manifesting users this time. ;)

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

(In [17015]) Final network admin help tweaks. props andrea_r, fixes #15314.

Fixed one misprint, removed trailing whitespace.

Found one more misprint and some trailing whitespace, see the patch above.

(In [17037]) Network admin contextual help fixes. props SergeyBiryukov, fixes #15314.

Thanks!

Improved wording.

Help on the Settings tab says “See the contextual help on the next tab”, however there are no more tabs. I've changed the string (see the patch). Or should we remove it?

The question now is whether we want all four tabs to say, "See the contextual help on the other tabs."?

We reordered them so we need to make sure the third tab (which used to be last) isn't missing the text.

The text is present on the third tab too. What is the best wording then?

Option for if we want all the tabs to say, "see the other tabs"

@nacin: one advantage of having all four tabs say "see the other tabs" would be if they were ever reordered again with a different one last, that last one would still be accurate.

  • Resolution fixed deleted
  • Status changed from closed to reopened

We had a nice little discussion about this a few hours ago, but forgot to re-open the ticket. I think Sergey's latest patch is more necessary than mine, but both are very simple and, in my opinion, an improvement.

Patch is fine. Will handle in the morning.

Sent a note to wp-docs regarding Codex link changes. I think we're going to modify the network admin codex links using a new structure. That'll be the last thing before string freeze tomorrow.

comment:32 follow-up: ↓ 36   nacin2 years ago

I'm just going to add the same help text across all four tabs.

Oops, wrong ticket reference: [17044]

(In [17045]) Move to what will be the new Network Admin Codex page URLs. see #15314.

(In [17046]) Network-specific language on the plugin and theme editor help tabs. props andrea_r, see #15314.

comment:36 in reply to: ↑ 32   SergeyBiryukov2 years ago

Replying to nacin:

I'm just going to add the same help text across all four tabs.

“See the other tabs” string is left on the Themes tab. I guess it should be removed for consistency.

(In [17051]) Remove old string. props SergeyBiryukov, see #15314.

What's left:

  • A new sentence on plugins.php (when in the network admin) that explains network activation/deactivation.

That's it.

What about something like, "Click the Netowrk activate link will activate the plugin on every site. plugin options will still need to be managed on a per-site basis." and the rest of those particulars & gotchas can be codexed.

Should there be a network-specifix Codex article to link to in this instance?

Version 0, edited 2 years ago by nacin (next)

Now that I think of it yes. It may exist as a blurb somewhere, might not need a whole page.

The Users menu needs a line something like "To search for user details, input the full username, or partial text with a wildcard." If it's too late, we can codex it.

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

I'm marking this as fixed after talking to Ryan. Any other details can go in the codex.

Note: See TracTickets for help on using tickets.