Description

Background

Not all of our projects will benefit from the addition of images and page descriptions. We'd like to make search configurable per project so that we can exclude them when necessary

Acceptance criteria

Allow images and page descriptions to be configurable per project
- Vector should expose two new configuration flags. The flags will have to be passed to the JavaScript client and specifically to the Vue instance. The default configuration should keep the flags enabled or unset so that third-parties get the best experience.
- WVUI's typeahead suggestion components will require two new component properties to be passed. When present, they will suppress presentation of thumbnail and / or description. The flags will be adjustable in the component's story and also any components that compose them in.
Config per project. The above projects will have the following set to on
- Commons
  - neither
- Wikidata
  - description
  - images
- Wikispecies
  - descriptions
  - images
- Wikibooks
  - neither
- Wikinews
  - images only
- Wikipedia
  - descriptions
  - images
- Wikiquote
  - descriptions
  - images
- Wikisource
  - neither
- Wikiversity
  - images
- Wikivoyage
  - descriptions
  - images
- Wiktionary
  - images only

A configuration patch will be submitted for the above projects to mediawiki-config in advance of changes merging to Vector.

Design

Prototype: https://di-search-3.web.app/Volvo

QA

To be done as part of T263657.

Details

	Subject	Repo	Branch	Lines +/-
	Add Wvui Config to show/hide thumbnails and descriptions	mediawiki/skins/Vector	master	+44 -4
	[components][typeahead-search][typeahead-suggestion] Add `showThumbnail`/`showDescription` props	wvui	master	+207 -8

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T49145 Formally deprecate jQuery UI after we've stopped using jQuery UI in extensions and core
Open	None	T100270 Replace use of jQuery UI and MW UI with OOUI across all Wikimedia-deployed extensions and core
Open	None	T85394 Use OOUI suggestions/autocompletion components only (instead of jquery.suggestions, jquery.ui.autocomplete)
Open	None	T125725 [epic] Update autocomplete search box with metadata and remove and delete the old searchSuggest system
Open	None	T177251 Dead keys prevent autocomplete in search box
Resolved	ovasileva	T244392 [GOAL] Deploy the new Vue.js search experience
Resolved	Volker_E	T249299 [Epic] Build the new Vue.js search experience
Resolved	ovasileva	T275200 Analyze results of A/B test for new search widget
Resolved	ovasileva	T249297 Deploy the new Vue.js search experience
Resolved	Edtadros	T259798 Deploy the new Vue.js search experience to the Beta-Cluster and Test Wikipedia
Declined	None	T257865 Merge feat/search to master for Vue.js search deployment
Resolved	ovasileva	T260167 Make new search widget configurable per project
Resolved	ovasileva	T263657 Style search widget results based on project configuration
Resolved	phuedx	T273090 Deploy modern Vector and new Vue.js search experience to new pilot wikis
Resolved	• alexhollender_WMF	T273085 Deploy more logos for new DIP pilot wikis
Resolved	ovasileva	T273477 Update Wikivoyage logos (Vector modern & mobile)
Duplicate	None	T264299 German Wikivoyage: select modern Vector skin as default
Resolved	• alexhollender_WMF	T252701 Spike: what to do with Wikivoyage icons in new design?
Resolved	MNeisler	T274869 Instrumentation QA for new search widget

Event Timeline

ovasileva created this task.Aug 11 2020, 4:41 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 11 2020, 4:41 PM

ovasileva triaged this task as High priority.Aug 11 2020, 4:41 PM

ovasileva edited projects, added Web-Team-Backlog (Kanbanana-FY-2020-21); removed Web-Team-Backlog.

• Niedzielski edited projects, added Design-Systems-team-20200324-20220422 (Vue.js Search Experience (Vector modern)); removed Design-Systems-team-20200324-20220422.Aug 11 2020, 4:43 PM

• Niedzielski added a parent task: T249299: [Epic] Build the new Vue.js search experience.

Seems like this would benefit from analysis from Stephen or someone more closely tied to the Vue work. Assigning Stephen for now who can delegate if necessary.

• Niedzielski removed • Niedzielski as the assignee of this task.Sep 2 2020, 8:42 PM

• Niedzielski updated the task description. (Show Details)

• Niedzielski subscribed.

• Niedzielski moved this task from Backlog to On Web Board on the Design-Systems-team-20200324-20220422 (Vue.js Search Experience (Vector modern)) board.Sep 14 2020, 6:22 PM

I'm not sure what the config for the Vue search looks like but would it suffice to have a JSON config of static values? Or does this need to be dynamic?

e.g.

var vueProps = Object.extend( {}, mw.config.get( 'wgVectorVueSearchConfig' ) );

If the above will work I think this is ready for estimation (and will take a similar approach to the work required for T263032). If I've misunderstood please move it back.

As far as I know, these configurations are statically defined per wiki.

ovasileva updated the task description. (Show Details)Sep 23 2020, 1:12 PM

ovasileva updated the task description. (Show Details)Sep 23 2020, 4:11 PM

ovasileva mentioned this in T263657: Style search widget results based on project configuration.Sep 23 2020, 4:15 PM

ovasileva set the point value for this task to 3.

ovasileva moved this task from Upcoming to Ready for Development on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.

• nray claimed this task.Oct 19 2020, 7:02 PM

• nray moved this task from Ready for Development to Doing on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.

• nray moved this task from Doing to Ready for Development on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Oct 20 2020, 5:09 PM

Putting this back into ready for dev until the network client ticket is resolved (I've assigned myself to that one). If anyone else wants to pick this up feel free to. If not, I will take it when the network client work has settled

• nray removed • nray as the assignee of this task.Oct 20 2020, 6:44 PM

• nray subscribed.

• nray claimed this task.Oct 27 2020, 4:09 PM

• nray moved this task from Ready for Development to Doing on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.

• nray removed • nray as the assignee of this task.Oct 29 2020, 3:56 PM

• nray moved this task from Doing to Code Review on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.

Change 637520 had a related patch set uploaded (by Nray; owner: Nray):
[wvui@master] [components][typeahead-search][typeahead-suggestion] Add showThumbnail/showDescription props

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

gerritbot added a project: Patch-For-Review.Oct 29 2020, 3:58 PM

Change 637520 merged by jenkins-bot:
[wvui@master] [components][typeahead-search][typeahead-suggestion] Add showThumbnail/showDescription props

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

Maintenance_bot removed a project: Patch-For-Review.Oct 29 2020, 11:10 PM

• nray claimed this task.Oct 30 2020, 4:55 PM

• nray moved this task from Code Review to Doing on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.

Jdlrobson added a parent task: T257865: Merge feat/search to master for Vue.js search deployment.Oct 30 2020, 5:45 PM

• nray moved this task from Doing to Blocked on Others on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Nov 2 2020, 6:20 PM

Final piece remaining on this is adding config in vector and passing that to the top level component (e.g. App.vue). For that we will need the integration bit (T264355) so I have moved this to blocked

• nray moved this task from Blocked on Others to Doing on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Nov 24 2020, 12:51 AM

Change 643598 had a related patch set uploaded (by Nray; owner: Nray):
[mediawiki/skins/Vector@master] Add Wvui Config to show/hide thumbnails and descriptions

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

gerritbot added a project: Patch-For-Review.Nov 26 2020, 1:01 AM