Update documentation for Wikipedia Preview plugin following its position change
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	SGautam_WMF
	Dec 21 2023, 9:59 AM

Description

Objective:

To revise and update the documentation related to the Wikipedia Preview plugin for WordPress in response to the recent change in the position(T352873) of the Wikipedia Preview option on the editing toolbar.

Places to update:

General description section on the Wikipedia Preview plugin page on WordPress.org.
Installation Tab on plugin page.
Change screenshot-1 from Screenshots section

Changes:

1. On the plugin homepage, under "Option 2 - How to add Wikipedia Preview links using Gutenberg/Block Editor".
Change second bullet point
From
Select ‘Wikipedia Preview’ from the menu.
To
Select ‘W’ - Wikipedia Preview icon from the menu.

2. On the Installation Tab of the plugin page, under "Option 2 - How to add Wikipedia Preview links using Gutenberg/Block Editor".

From
Select ‘Wikipedia Preview’ from the menu.
To
Select ‘W’ - Wikipedia Preview icon from the menu.

3. Replace the current instructional screenshot with a new one that displays the updated 'W' icon interface.

From

4. Club step 1 & step 2 in onboarding screen which shows up right after installing the plugin
From(production version)**

Screenshot 2024-01-15 at 2.19.59 PM.png (1×2 px, 824 KB)

To(mockup)

03 Detailed instructional graphics.png (2×1 px, 432 KB)

Figma file

Acceptance criteria:

All references to the location and usage of the Wikipedia Preview option in the documentation should accurately reflect its new position.
Verify that all links and references within the documentation are functional and direct to the correct information.

QA Results - WordPress

AC	Status	Details
1	✅	https://phabricator.wikimedia.org/T353866 here

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		None	T327100 Improve Experience for Site Owners & Readers using Wikipedia Preview Plugin
		Resolved		eamedina	T353866 Update documentation for Wikipedia Preview plugin following its position change

Event Timeline

SGautam_WMF created this task.Dec 21 2023, 9:59 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 21 2023, 10:00 AM

SGautam_WMF mentioned this in T352873: Change position of Wikipedia Preview option on the editing toolbar.Dec 21 2023, 10:00 AM

PWaigi-WMF added a parent task: T327100: Improve Experience for Site Owners & Readers using Wikipedia Preview Plugin.Dec 21 2023, 10:30 AM

PWaigi-WMF moved this task from Backlog to Definition on the Inuka-Team (Kanban) board.Jan 12 2024, 9:31 AM

SGautam_WMF updated the task description. (Show Details)Jan 15 2024, 8:36 AM

SGautam_WMF updated the task description. (Show Details)Jan 15 2024, 8:48 AM

@SBisson we would also need to make a change to the onboarding steps as current one still uses the dropdown menu for Wikipedia Preview option. Shall we create a separate task for that or we can use this one only?

From(production version)

To(mockup)

03 Detailed instructional graphics.png (2×1 px, 493 KB)

PWaigi-WMF updated the task description. (Show Details)Jan 15 2024, 9:32 AM

In T353866#9458941, @SGautam_WMF wrote:

Shall we create a separate task for that or we can use this one only?

use this one is fine.

In T353866#9459216, @hueitan wrote:

In T353866#9458941, @SGautam_WMF wrote:

Shall we create a separate task for that or we can use this one only?

use this one is fine.

Thanks @hueitan, added it in task description.

PWaigi-WMF triaged this task as Medium priority.Jan 15 2024, 4:10 PM

PWaigi-WMF moved this task from Definition to Ready for Dev on the Inuka-Team (Kanban) board.

eamedina claimed this task.Jan 16 2024, 3:52 PM

eamedina moved this task from Ready for Dev to Dev on the Inuka-Team (Kanban) board.

https://github.com/wikimedia/wikipediapreview-wordpress/pull/104

eamedina moved this task from Dev to Code Review on the Inuka-Team (Kanban) board.Jan 19 2024, 1:49 AM

@SGautam_WMF I updated the post-installation onboarding screen by removing second step and updating the first step text to "Highlight the text and select ‘W’- Wikipedia Preview from the menu", as discussed earlier. Please feel free to update ticket description as you see fit.

In T353866#9478658, @eamedina wrote:

@SGautam_WMF I updated the post-installation onboarding screen by removing second step and updating the first step text to "Highlight the text you want to link to a Wikipedia article and select ‘W’- Wikipedia Preview from the menu", as discussed earlier. Please feel free to update ticket description as you see fit.

Thanks @eamedina, made changes to task description.

SBisson moved this task from Code Review to QA on the Inuka-Team (Kanban) board.Jan 25 2024, 2:26 PM

@eamedina @SGautam_WMF Figma and the onboard after installation instructions have been updated to the "W" icon as seen in the screenshot and .webm below. This will be moved to Design Sign-off. Thanks for all your work!

Status: ✅PASS
Environment: Wordpress 6.4.3
OS: macOS Sonoma 14.2.1
Browser: Chrome 121
Skins. N/A
Device: MBA M2
Emulated Device:: n/a
Test Links:
http://dev-test.local/wp-admin/options-general.php?page=wikipediapreview_intro

✅AC1: https://phabricator.wikimedia.org/T353866

Figma	Onboard

GMikesell-WMF updated the task description. (Show Details)Feb 21 2024, 12:06 AM

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

GMikesell-WMF moved this task from QA to Design sign off on the Inuka-Team (Kanban) board.

SGautam_WMF moved this task from Design sign off to Product sign off on the Inuka-Team (Kanban) board.Mon, Apr 15, 5:05 AM

PWaigi-WMF closed this task as Resolved.Tue, Apr 16, 12:31 PM

	F42006974: T353866_Wikipediapreview_OnboardUpdate.webm
	Feb 21 2024, 12:04 AM

	F41708530: 03 Detailed instructional graphics.png
	Jan 23 2024, 12:09 AM

	F41690961: 03 Detailed instructional graphics.png
	Jan 15 2024, 8:51 AM

	F41690958: Screenshot 2024-01-15 at 2.19.59 PM.png
	Jan 15 2024, 8:51 AM

Update documentation for Wikipedia Preview plugin following its position changeClosed, ResolvedPublicActions