Community Configuration: Help Links
Open, MediumPublic
Actions

Assigned To

Authored By

	KStoller-WMF
	Tue, Apr 9, 10:53 PM

Description

User story & summary:

As a Wikimedian wanting to learn more about a particular Community Configuration setting, I want to easily access an associated help page, so that I can learn more and ask questions if needed.

Design:

Figma designs

Help Links

Mentorship: https://www.mediawiki.org/wiki/Help:Growth/Mentorship
Help Panel: https://www.mediawiki.org/wiki/Growth/Feature_summary#Help_panel
Newcomer Homepage: https://www.mediawiki.org/wiki/Growth/Feature_summary#Newcomer_homepage
Suggested Edits: https://www.mediawiki.org/wiki/Help:Growth/Tools/Suggested_edits

Acceptance Criteria:

Given I'm viewing Community Configuration,
When I'm viewing a GrowthExperiments configuration form,
Then each form has a linked Help page.

Details

Subject	Repo	Branch	Lines +/-
Add `helpLink` and `helpURL` to extension.json	mediawiki/extensions/GrowthExperiments	master	+16 -4
Add help link to the configuration form	mediawiki/extensions/CommunityConfiguration	master	+16 -0
Add help link to the configuration form	mediawiki/extensions/CommunityConfiguration	master	+25 -88

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T226350 Special pages help links [Tracking]
Open	Cyndymediawiksim	T362203 Community Configuration: Help Links
Resolved	Cyndymediawiksim	T363356 Use an array of options for configuring a provider

Event Timeline

KStoller-WMF created this task.Tue, Apr 9, 10:53 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptTue, Apr 9, 10:53 PM

KStoller-WMF triaged this task as Medium priority.Tue, Apr 9, 10:53 PM

KStoller-WMF moved this task from Inbox to Up Next on the Growth-Team board.

KStoller-WMF moved this task from Backlog to Needed before pilot release on the CommunityConfiguration board.

KStoller-WMF mentioned this in T361324: [QA task] Community Configuration UI evaluation .Wed, Apr 10, 11:27 PM

Would it be okay if the "View History" link lead directly to eg. https://es.wikipedia.beta.wmflabs.org/w/index.php?title=MediaWiki:GrowthExperimentsMentorship.json&action=history (where there would be no obvious way to get back)? Or do we want to do something to make this more clear?

Couldn’t the action=history page be made linking back to Special:CommunityConfiguration? Similarly to VisualEditor’s Edit link, Community Configuration provides an alternate edit view of the same page, so putting its link among the content actions would make sense. (And even vice versa: simply call Skin::setRelevantTitle() on Special:CommunityConfiguration, which gives a history link, a talk page link etc. for free.)

Cyndymediawiksim moved this task from Up Next to Sprint 12 (Growth Team) on the Growth-Team board.Mon, Apr 22, 10:00 AM

Cyndymediawiksim edited projects, added Growth-Team (Sprint 12 (Growth Team)); removed Growth-Team.

Cyndymediawiksim claimed this task.Mon, Apr 22, 10:02 AM

Cyndymediawiksim moved this task from Incoming to Doing on the Growth-Team (Sprint 12 (Growth Team)) board.

Cyndymediawiksim added a subscriber: Sgs.Wed, Apr 24, 9:08 AM

This comment was removed by Cyndymediawiksim.

Cyndymediawiksim added a subscriber: Urbanecm.Wed, Apr 24, 9:09 AM

Restricted Application removed a subscriber: Urbanecm. · View Herald TranscriptWed, Apr 24, 9:09 AM

In T362203#9707924, @Tacsipacsi wrote:

Couldn’t the action=history page be made linking back to Special:CommunityConfiguration? Similarly to VisualEditor’s Edit link, Community Configuration provides an alternate edit view of the same page, so putting its link among the content actions would make sense. (And even vice versa: simply call Skin::setRelevantTitle() on Special:CommunityConfiguration, which gives a history link, a talk page link etc. for free.)

@Tacsipacsi, The suggestion to use Skin::setRelevantTitle() on Special:CommunityConfiguration is a great idea as it would directly link to the history page of the relevant configuration file. However, this approach could lead to a situation where there is no obvious way for users to navigate back to the Special:CommunityConfiguration page from the history page as @Urbanecm_WMF highlighted above.

To address this we could consider implementing a solution, where a return link is prominently displayed, allowing users to easily switch back to the Special:CommunityConfiguration page.

For example, we could add a “Return to Community Configuration” link at the top of the history page. This would ensure that users have a clear and convenient way to navigate back to the main configuration page after reviewing the history.

cc:@Urbanecm_WMF, @Sgs

In T362203#9705899, @Urbanecm_WMF wrote:

Would it be okay if the "View History" link lead directly to eg. https://es.wikipedia.beta.wmflabs.org/w/index.php?title=MediaWiki:GrowthExperimentsMentorship.json&action=history (where there would be no obvious way to get back)? Or do we want to do something to make this more clear?

tagging @KStoller-WMF, for visibility :)

In T362203#9739550, @Cyndymediawiksim wrote:

However, this approach could lead to a situation where there is no obvious way for users to navigate back to the Special:CommunityConfiguration page from the history page as @Urbanecm_WMF highlighted above.

This is what the link among the content actions aims to solve.

Change #1023827 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/CommunityConfiguration@master] Add help link to the configuration form

https://gerrit.wikimedia.org/r/1023827

gerritbot added a project: Patch-For-Review.Wed, Apr 24, 10:57 AM

In T362203#9739672, @Tacsipacsi wrote:

In T362203#9739550, @Cyndymediawiksim wrote:

However, this approach could lead to a situation where there is no obvious way for users to navigate back to the Special:CommunityConfiguration page from the history page as @Urbanecm_WMF highlighted above.

This is what the link among the content actions aims to solve.

@Tacsipacsi,for my clarification, what you are suggesting is adding a link to Special:CommunityConfigurations among these content actions, meaning that when a user is viewing the history page of a configuration file, there would be a tab that links directly to the Special:CommunityConfiguration page?

Yes, except that the link (tab) could appear on every page action (including view, source code editing etc.) rather than only on the history action; and that I used wrong terminology: it’s a view, not a content action. You can use SkinTemplateNavigation::Universal.

Sgs mentioned this in T363356: Use an array of options for configuring a provider.Wed, Apr 24, 5:14 PM

KStoller-WMF renamed this task from Community Configuration: Edit History & Help Links to Community Configuration: Help Links.Tue, Apr 30, 3:46 AM

KStoller-WMF updated the task description. (Show Details)

I've separated this into two tasks. This task now only covers adding Help links.

Here is the other task: T363788: Community Configuration: Edit History

In T362203#9705899, @Urbanecm_WMF wrote:
Would it be okay if the "View History" link lead directly to eg. https://es.wikipedia.beta.wmflabs.org/w/index.php?title=MediaWiki:GrowthExperimentsMentorship.json&action=history (where there would >be no obvious way to get back)? Or do we want to do something to make this more clear?

I'll start this discussion in the other task.

KStoller-WMF mentioned this in T363788: Community Configuration: Edit History.Tue, Apr 30, 3:55 AM

Sgs moved this task from Doing to Code Review on the Growth-Team (Sprint 12 (Growth Team)) board.Tue, Apr 30, 11:44 AM

KStoller-WMF moved this task from Sprint 12 (Growth Team) to Sprint 13 (Growth Team) on the Growth-Team board.Wed, May 1, 11:37 PM

KStoller-WMF edited projects, added Growth-Team (Sprint 13 (Growth Team)); removed Growth-Team (Sprint 12 (Growth Team)).

Cyndymediawiksim moved this task from Incoming to Doing on the Growth-Team (Sprint 13 (Growth Team)) board.Thu, May 2, 7:07 AM

Cyndymediawiksim moved this task from Doing to Code Review on the Growth-Team (Sprint 13 (Growth Team)) board.Thu, May 2, 7:45 AM

Sgs moved this task from Code Review to Doing on the Growth-Team (Sprint 13 (Growth Team)) board.Fri, May 3, 9:21 AM

Change #1028480 had a related patch set uploaded (by Cyndywikime; author: Cyndywikime):

[mediawiki/extensions/CommunityConfiguration@master] Add help link to the configuration form

https://gerrit.wikimedia.org/r/1028480

Change #1023827 abandoned by Cyndywikime: