WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#13736 closed defect (bug) (fixed)

Review codex links from Help Text

Reported by: zeo Owned by:
Milestone: 3.0 Priority: normal
Severity: normal Version: 3.0
Component: Administration Keywords: i18n-change needs-codex
Focuses: Cc:

Description

All links that points to Codex need to be reviewed.

A few of them are just placeholder (for example: http://codex.wordpress.org/Super_Admin_Sites_SubPanel) which is fine. Why not create a placeholder for other sub panel/menu too?

For example, Comment-> Edit Comment-> Help tab, under "More information:" there's a link to http://codex.wordpress.org/Administration_Panels#Comments. Why not add additional link to http://codex.wordpress.org/Comments_Edit_Comment_SubPanel?

I think it's better to add an empty placeholder page in Codex rather than adding any existing Codex page that are too general, useless or obsolete. At least we can fill the empty Codex page after the release.

Attachments (21)

13736-ms-admin.php.diff (1.1 KB) - added by zeo 7 years ago.
Fix Super Admin > Admin codex link
13736-ms-users.php.diff (1.1 KB) - added by zeo 7 years ago.
13736-ms-options.php.diff (1.1 KB) - added by zeo 7 years ago.
13736-ms-upgrade-network.php.diff (934 bytes) - added by zeo 7 years ago.
13736-index.php-dashboard.diff (1005 bytes) - added by zeo 7 years ago.
13736-my-sites.php.diff (1.0 KB) - added by zeo 7 years ago.
13736-update-core.php.diff (1.7 KB) - added by zeo 7 years ago.
13736-edit.php.diff (1.9 KB) - added by zeo 7 years ago.
13736-options-privacy.php.diff (1.0 KB) - added by zeo 7 years ago.
13736-options-permalink.php.diff (1.4 KB) - added by zeo 7 years ago.
13736-options-discussion.php.diff (1.1 KB) - added by zeo 7 years ago.
13736-options-reading.php.diff (1017 bytes) - added by zeo 7 years ago.
13736-network.php.diff (1.4 KB) - added by zeo 7 years ago.
13736-export.php.diff (1.2 KB) - added by zeo 7 years ago.
13736-import.php.diff (1.2 KB) - added by zeo 7 years ago.
13736-tools.php.diff (1.2 KB) - added by zeo 7 years ago.
13736-users.php.diff (1.3 KB) - added by zeo 7 years ago.
13736-Appearance.diff (8.9 KB) - added by zeo 7 years ago.
13736-Comments.diff (2.9 KB) - added by zeo 7 years ago.
13736.diff (22.6 KB) - added by zeo 7 years ago.
Merging all patches above. Add and corrected missing link to codex.
13736.last-stand.diff (3.8 KB) - added by nacin 7 years ago.

Download all attachments as: .zip

Change History (45)

#1 @Arlen22
7 years ago

How about having one place for all links. Then the links would look like http://codex.wordpress.org/Codex:WPHelp/Super_Admin/Sites_Subpanel which would redirect to the correct page.

#2 follow-up: @nacin
7 years ago

  • Keywords needs-codex added

I fail to see a difference in sending traffic to unique links only to redirect to "proper" unique links, versus just linking them to the correct page to begin with.

zeo, as mentioned on IRC, I've sent an email to the docs team so they can weigh in on this. Ultimately it's up to them for what they feel is worth a page itself, versus something that only ought to be a section.

#3 @michaelh
7 years ago

Use this:

http://codex.wordpress.org/Comments_Comments_SubPanel

It's redirecting to Combating Spam while a more useful article is implemented.

#4 @nacin
7 years ago

It looks like Comments_Comments_SubPanel is linked to in the initial link, Administration_Panels#Comments.

Just a note, the help text on edit-comments.php also has a link to http://codex.wordpress.org/Comment_Spam, which appears to be a different page altogether.

#5 @michaelh
7 years ago

I'm make it point to clean that up.

#6 in reply to: ↑ 2 @Arlen22
7 years ago

Replying to nacin:

I fail to see a difference in sending traffic to unique links only to redirect to "proper" unique links, versus just linking them to the correct page to begin with.

zeo, as mentioned on IRC, I've sent an email to the docs team so they can weigh in on this. Ultimately it's up to them for what they feel is worth a page itself, versus something that only ought to be a section.

I suppose you wouldn't need to update the links as often.

#7 @zeo
7 years ago

  • Cc zeo@… added

#8 follow-up: @zeo
7 years ago

Since no one entertain my question in wp-docs (everyone is busy with that license thingy), so I copy paste it here.

Posts (Menu or Panel?)
\_ Posts (SubPanel?)
\_ Add New
\_ Categories
...

I failed to find any NEW reference regarding this, whether it should be Posts Menu or Posts Panel, Posts SubMenu or Posts SubPanel.

For example: in phpdoc or comment, WordPress uses Panel but for codex link (under Help tab) it uses Menu.

#9 @nacin
7 years ago

I believe we actually want to start gravitate to "screens", but I doubt we will want to break dozens of strings (and force a lot of codex edits and redirects) on short notice.

#10 in reply to: ↑ 8 @michaelh
7 years ago

Replying to zeo:

Since no one entertain my question in wp-docs (everyone is busy with that license thingy), so I copy paste it here.

Posts (Menu or Panel?)
\_ Posts (SubPanel?)
\_ Add New
\_ Categories
...

Sorry didn't quite realize the question, but know that http://codex.wordpress.org/Administration_Panels will eventually get you to the appropriate 'SubPanel'.

The docs you asked about above:

http://codex.wordpress.org/Posts_Posts_SubPanel

http://codex.wordpress.org/Posts_Add_New_SubPanel

http://codex.wordpress.org/Posts_Categories_SubPanel

http://codex.wordpress.org/Posts_Post_Tags_SubPanel

#11 @jane
7 years ago

Where the Codex uses Panel/Subpanel, the help text uses "Screen." It's okay that they don't match, since it's a recent switch and has not been applied to the Codex.

#12 @nacin
7 years ago

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

Closing as fixed; looks like everything will be handled from the Codex side.

@zeo
7 years ago

Fix Super Admin > Admin codex link

@zeo
7 years ago

@zeo
7 years ago

@zeo
7 years ago

@zeo
7 years ago

@zeo
7 years ago

@zeo
7 years ago

@zeo
7 years ago

#13 @zeo
7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

My apology for multiple patches.

Please use 13736.diff. http://core.trac.wordpress.org/attachment/ticket/13736/13736.diff combined all of the patches above.

In the patch:

  • Add and corrected missing link to codex.

Someone from wp-docs team please review.

#14 @nacin
7 years ago

Please revert all changes from that patch which only involve changing the label.

Adding or changing a link can then be approved on a case-by-case basis.

As few changes as possible, or none of them are going to get in.

@zeo
7 years ago

Merging all patches above. Add and corrected missing link to codex.

#15 follow-up: @michaelh
7 years ago

zeo - Those links you are using to Codex look good.

#16 @nacin
7 years ago

We don't want to make so many changes at this stage and would rather handle any other juggling on the Codex side.

Please see the attached. Three links missing where no other links are present.

#17 in reply to: ↑ 15 @zeo
7 years ago

Replying to michaelh:

zeo - Those links you are using to Codex look good.

Not sure about this one. In patch i use http://codex.wordpress.org/Super_Admin_Sites_SubPanel#Editing_Individual_Sites

Or it should be http://codex.wordpress.org/Super_Admin_Sites_SubPanel#Edit_Site

#19 @nacin
7 years ago

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

#20 @nacin
7 years ago

Sorry, [15231].

#21 follow-up: @Viper007Bond
7 years ago

I thought we were in string freeze already? These recent changesets are changing strings.

#22 in reply to: ↑ 21 @nacin
7 years ago

Replying to Viper007Bond:

I thought we were in string freeze already? These recent changesets are changing strings.

In this case, we added 3 strings where it was felt particularly important -- the lack of a link to specific Codex documentation on three new 3.0 features. I've been emailing translators with each string addition, deletion, and modification since RC2.

#23 follow-up: @zeo
7 years ago

I hope in the future before someone in the core-committer decide to string freeze, re-check every new string that comes in. It's sad to see that the new Help tab/text is not properly polished. The patch is there but was too late.

Even this is a minor issue, I hope this can be improved in future release.

#24 in reply to: ↑ 23 @nacin
7 years ago

Replying to zeo:

I hope in the future before someone in the core-committer decide to string freeze, re-check every new string that comes in. It's sad to see that the new Help tab/text is not properly polished. The patch is there but was too late.

We generally freeze strings with an RC; because of help, we froze with RC2. Now we're in RC3, with the goal of releasing early next week. We freeze strings that way translators of the dozens of localizations have time to complete the process prior to the main release that way the internationalized users can ride the hype as well and upgrade with the rest of us. We already burdened the translators with both multisite and (on a smaller scale, but late in the game) help this cycle; they enable international adoption and we need to be respectful of their time-consuming and tedious process. That means only breaking strings when we need to. The strings are plenty polished.

I meticulously and methodically reviewed the larger patch and chose the strings I felt we needed to add or change. None of the other suggestions in the patch are critical changes, or even fixing mistakes. Most are either style changes, due to our personal preference that we can handle in a future release, or Codex link changes, some of which are due to new or changed pages on the Codex or renamed screens in admin, which we can handle on the Codex side. I'd prefer that we're complete and correct, but we don't need to be perfect.

Note: See TracTickets for help on using tickets.