WordPress.org

Make WordPress Core

Opened 2 years ago

Last modified 8 weeks ago

#23163 closed enhancement

3.6 Network Admin Help Text — at Version 5

Reported by: DrewAPicture Owned by:
Milestone: Priority: low
Severity: normal Version:
Component: Help/About Keywords: has-patch
Focuses: Cc:

Description (last modified by DrewAPicture)

One of the Doc team's action items for 3.6 is to work on overhauling the Network Admin help tabs, many of which contain outdated and, well, unhelpful information.

Our goals:

  • Focus on writing action vs description-based help text
  • Aim for a consistent voice
  • Pave the way for future Help UI changes in how we structure the information

Any Network Admin screen is fair game but by no means do we intend to change strings just for the sake of change. It was the consensus of the team to focus on this effort earlier in the release cycle than usual so that translators will have plenty of time to work on new strings and provide feedback.

Following some feedback from @nacin, @markjaquith, and @aaroncampbell, it was decided the best format for concatenating help tabs strings should follow this format going forward:

$example_string = '<p>' . __( 'This is some help text' ) . '</p>';
$example_string .= '<p>' . __( 'This is some more help text' ) . '</p>';
 
get_current_screen()->add_help_tab( array(
'id'	=> 'example',
'title'	=> __( 'Example' ),
'content'	=> $example_string
) );

Change History (7)

@DrewAPicture2 years ago

/network/index.php (Dashboard)

comment:1 @DrewAPicture2 years ago

  • Keywords has-patch added

23163.diff gets the ball rolling with changes to the main network index help text.

Before:

Overview:

Until WordPress 3.0, running multiple sites required using WordPress MU instead of regular WordPress. In version 3.0, these applications have merged. If you are a former MU user, you should be aware of the following changes:

  • Site Admin is now Super Admin (we highly encourage you to get yourself a cape!).
  • Blogs are now called Sites; Site is now called Network.

The Right Now box provides the network administrator with links to the screens to either create a new site or user, or to search existing users and sites. Screens for Sites and Users are also accessible through the left-hand navigation in the Network Admin section.

After:

Overview:

Welcome to your Network Admin. This area of the Dashboard is used for managing all aspects of your Multisite network.

The menus on the left side allow you to:

  • Add and manage sites or users
  • Install and activate themes or plugins
  • Update your network
  • Modify global network settings

Quick Tasks:

The Right Now widget on this screen provides current user and site counts on your network. New users and sites are easily created by clicking the ‘Create a New Site’ or ‘Create a New User’ links.

You can also search for any user or site in your network by using the search boxes. Users can be searched by entering all or part of a username or email address. Sites are searchable by path or domain, depending on which type of network you have.

Last edited 2 years ago by DrewAPicture (previous) (diff)

comment:2 @raggedrobins2 years ago

  • Cc siobhan@… added

comment:3 @Ipstenu2 years ago

  • Cc ipstenu@… added

comment:4 @DrewAPicture2 years ago

23163.1-DJ-SM.diff is a second pass at /network/index.php from Drew & Siobhan.

Overview: http://cl.ly/image/330Y243r2O2q

Quick Tasks: http://cl.ly/image/2g2h3B1Y0x3H

Last edited 2 years ago by DrewAPicture (previous) (diff)

comment:5 @DrewAPicture2 years ago

  • Description modified (diff)

@DrewAPicture2 years ago

/network/index.php (Dashboard) 2nd pass

Note: See TracTickets for help on using tickets.