RelatedArticles max number of articles limit should be configurable
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	Jdlrobson
	May 8 2017, 4:27 PM

Description

Wikivoyage's use of RelatedArticles predates the reboot done by the reading web team. They have been using the extension to manually curate lists of related articles on a variety of pages. For instance on the page Japan:

Screen Shot 2017-06-13 at 11.35.44 AM.png (519×370 px, 81 KB)

For the community to continue to adopt the new version of the extension which shows cards in the footer... and allow us to remove the legacy sidebar code... on Wikivoyage it should be possible to have more than 3 related pages using the RelatedArticles extension so that it doesn't hide content they've already provided.

Sign off

This can be signed off on 12th July on wikivoyage
1 article: https://en.wikivoyage.org/wiki/The_Jazz_Track
3 articles: https://en.wikivoyage.org/wiki/UNESCO_World_Heritage_List
4 articles: https://en.wikivoyage.org/w/index.php?title=Canada
6 articles: https://en.wikivoyage.org/w/index.php?title=Japan

On https://en.m.wikivoyage.org/wiki/Japan for example there are 5 related pages. All 5 should be shown.

Appearance

footer on desktop copy.png (1×2 px, 306 KB)

5
You get the idea

Acceptance criteria

The RelatedArticles extension has a configurable limit which defaults to 3
The limit is disabled on Wikivoyage projects
The limit is 3 on all other projects

Details

	Subject	Repo	Branch	Lines +/-
	Wikivoyage projects can show more than 3 related articles	operations/mediawiki-config	master	+5 -0
	Make number of RelatedArticles configurable	mediawiki/extensions/RelatedArticles	master	+63 -10

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Resolved	Jdlrobson	T162936 Improve developer happiness in reading web maintained extensions
Resolved	phuedx	T165991 Remove sidebar code from RelatedArticles extension
Resolved	• Nirzar	T164765 RelatedArticles max number of articles limit should be configurable

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 8 2017, 4:27 PM

Jdlrobson mentioned this in T164391: Switch Related Articles on Wikivoyage from sidebar to footer.May 8 2017, 4:27 PM

Jdlrobson added a project: Web-Team-Backlog.May 8 2017, 5:28 PM

Jdlrobson moved this task from Incoming to Needs Prioritization on the Web-Team-Backlog board.

• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.May 9 2017, 10:07 AM

• Qse24h closed this task as a duplicate of T164723: New git repository: <repo name>.

Aklapper reopened this task as Open.May 9 2017, 10:19 AM

ovasileva triaged this task as Low priority.May 9 2017, 3:04 PM

ovasileva edited projects, added Design, Web-Team-Backlog (Design); removed Web-Team-Backlog.

I've already checked this with Nirzar

Bumping priority as this allows us to remove a bunch of code from relatedarticles and yay scope decrease.

Jdlrobson moved this task from Triaged but Future to Upcoming on the Web-Team-Backlog board.May 24 2017, 3:12 PM

Jdlrobson mentioned this in T165991: Remove sidebar code from RelatedArticles extension.May 24 2017, 3:28 PM

This patch should take care of this:

p.patch2 KBDownload

Change 355636 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/extensions/RelatedArticles@master] Make number of RelatedArticles configurable

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

gerritbot added a project: Patch-For-Review.May 25 2017, 6:03 PM

Jdlrobson claimed this task.May 25 2017, 6:03 PM

Jdlrobson added projects: Readers-Web-Kanbanana-Board-Old, Unplanned-Sprint-Work.

Jdlrobson moved this task from To Do to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.

After applying the above patch, this is what I see:

Screenshot from 2017-05-25 16-05-00.png (640×1 px, 97 KB)

Ack! Good spot @bmansurov I guess this is not as trivial as first thought.
@Nirzar can you provide some guidance on how it should look on tablets when there are 4 (https://phabricator.wikimedia.org/T164765#3293142)?

Jdlrobson added a parent task: T165991: Remove sidebar code from RelatedArticles extension.May 26 2017, 5:41 PM

Jdlrobson changed the task status from Open to Stalled.May 26 2017, 7:24 PM

Jdlrobson changed the task status from Stalled to Open.

Jdlrobson added a project: Patch-Needs-Improvement.Jun 5 2017, 3:30 PM

The cards can be laid out like this but can we add a comment somewhere for people who want to configure this saying suggested values 3|6|9?

5
You get the idea

I'm not sure where to put the comment, but yeh I can start a conversation on the wiki about how to message that out. This is only Wikivoyage and pages rarely have any related articles at all - so I don't think this is going to be a big problem.

And patch updated :)

Jdlrobson claimed this task.Jun 7 2017, 4:59 PM

Jdlrobson moved this task from Upcoming to Triaged but Future on the Web-Team-Backlog board.Jun 7 2017, 5:07 PM

Jdlrobson moved this task from Triaged but Future to Upcoming on the Web-Team-Backlog board.Jun 9 2017, 4:08 PM

@Jdlrobson, @Nirzar - did we come to a conclusion on number of cards?

On Wikivoyage it should be possible to have more than 3 related pages using the RelatedArticles extension.

Why?

why do we need max limit here? if we are letting people change it anyways? if someone puts 1000 then they would see 1000 cards, which is expected and I think fine.

Jdlrobson updated the task description. (Show Details)Jun 13 2017, 6:36 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson moved this task from Needs Prioritization to Upcoming on the Web-Team-Backlog board.

@Jdlrobson

The RelatedArticles extension has a configurable limit which defaults to unlimited

though i said it shouldn't have a limit, we can define the "default" to 3. and let it be configurable to unlimited

Jdlrobson updated the task description. (Show Details)Jun 13 2017, 6:38 PM

Jdlrobson updated the task description. (Show Details)Jun 22 2017, 11:25 PM

Jdlrobson edited projects, added Readers-Web-Kanbanana-Board-Old, Unplanned-Sprint-Work; removed Patch-Needs-Improvement.

Jdlrobson moved this task from Upcoming to 2016-17 Q4 on the Web-Team-Backlog board.

@Jdlrobson - what was the final decision on this? How'd it end up in the sprint?

phuedx moved this task from Needs Code Review to Needs More Work on the Readers-Web-Kanbanana-Board-Old board.Jun 28 2017, 3:36 PM

Jdlrobson moved this task from Needs More Work to To Do on the Readers-Web-Kanbanana-Board-Old board.Jun 28 2017, 5:07 PM

Jdlrobson set the point value for this task to 3.Jun 28 2017, 5:35 PM

Jdlrobson moved this task from To Do to Needs Design Review on the Readers-Web-Kanbanana-Board-Old board.

Jdlrobson moved this task from Needs Design Review to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.Jun 29 2017, 12:32 AM

The change doesn't integrate – I'm sure this is a minor issue.
There's a question from @pmiazga on PS3 that wasn't answered.
There's now a question from me on PS4 about the search API's handling of limit=-1.

All fixed. my bad!

• bmansurov moved this task from Needs Code Review to Needs More Work on the Readers-Web-Kanbanana-Board-Old board.Jul 3 2017, 9:56 PM

Jdlrobson moved this task from Needs More Work to Needs Code Review on the Readers-Web-Kanbanana-Board-Old board.Jul 3 2017, 10:43 PM

• bmansurov moved this task from Needs Code Review to Needs More Work on the Readers-Web-Kanbanana-Board-Old board.Jul 6 2017, 3:55 PM

Yeh looks like this doesn't work on the desktop resolution. I'm going to try a different approach with the styling.

The combination of the fixed pixel margin-right and percentage width were causing the issues so I've switched the margin-right to a percentage. Visually it's more or less the same.
Nirzar can you confirm you're okay with the slight change in margins on cards (should not be noticeable)
http://reading-web-staging.wmflabs.org/wiki/Related

I really would like to put work to RelatedArticles to bed...

Patch is here: https://gerrit.wikimedia.org/r/#/c/355636/15

yeah I think % margin works... Thanks for fixing.. let's 📦 it

The main patch has been +2'ed. Do we have a patch for the following requirement?

The limit is disabled on Wikivoyage projects

Change 355636 merged by jenkins-bot:
[mediawiki/extensions/RelatedArticles@master] Make number of RelatedArticles configurable

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

Change 363742 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[operations/mediawiki-config@master] Wikivoyage projects can show more than 1 related article

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

I can do the swat deploy today in 1hr. Skipping QA as Nirzar has checked this and can check again as part of sign off.

Change 363742 merged by jenkins-bot:
[operations/mediawiki-config@master] Wikivoyage projects can show more than 3 related articles

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

Sign off currently blocked till next Wednesday...

ReleaseTaggerBot added a project: MW-1.30-release-notes (WMF-deploy-2017-07-11_(1.30.0-wmf.9)).Jul 8 2017, 4:01 AM

Macro votecat: looks good

MBinder_WMF moved this task from 2016-17 Q4 to 2017-18 Q1 on the Web-Team-Backlog board.Mar 6 2018, 6:51 PM

	F8454356: Screen Shot 2017-06-13 at 11.35.44 AM.png
	Jun 13 2017, 6:36 PM

	F8182207: Screenshot from 2017-05-25 16-05-00.png
	May 25 2017, 8:05 PM

	F8398292: footer on desktop.png
	Jun 7 2017, 11:36 AM

	F8176334: p.patch
	May 24 2017, 5:59 PM

RelatedArticles max number of articles limit should be configurableClosed, ResolvedPublic3 Estimated Story PointsActions