iBet uBet web content aggregator. Adding the entire web to your favor.
iBet uBet web content aggregator. Adding the entire web to your favor.



Link to original content: http://phabricator.wikimedia.org/T321102
⚓ T321102 [Dev cleanup] Remove broken storybook and jsdoc from Vector
Page MenuHomePhabricator
Create Task
Maniphest T321102

[Dev cleanup] Remove broken storybook and jsdoc from Vector
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

Background

Based off discussion in slack, we decided to remove storybook due to the difficulty in reproducing Vector's test cases and therefore higher maintenance cost, and its limited utility in comparison to other tools like Pixel

In https://gerrit.wikimedia.org/r/838233 Storybook stopped working.

During SHDT meeting the developers agreed that supporting jsdoc is more effort than the value it provides and conflicts with TypeScript typechecking, so we should also remove the jsdoc command.

AC

  • Storybook and its dependencies are removed from Vector
  • Remove jsdoc command from npm test and npm doc command to stop generating jsdoc documentation.

sign off steps

  • discuss and document in our dev notes why storybook didn't work out for our project
  • track any follow up items from the dev discussion in phab

Details

Other Assignee
bwang
SubjectRepoBranchLines +/-
Remove Storybook and jsdoc and its dependenciesmediawiki/skins/VectorREL1_39+3 K -31 K
Remove docs from Vector CIintegration/configmaster+0 -1
Remove Storybook and jsdoc and its dependenciesmediawiki/skins/Vectormaster+196 -22 K
[Technical] Split up Menu.template, restrict decoratePortletData to legacy Vectormediawiki/skins/Vectormaster+313 -231
Customize query in gerrit

Related Objects

Event Timeline

bwang created this task.Oct 18 2022, 4:11 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 18 2022, 4:11 PM
bwang added projects: Desktop Improvements (Vector 2022), Web-Team-Backlog (Kanbanana-2022-23-Q2).Oct 18 2022, 4:13 PM
bwang updated the task description. (Show Details)
bwang moved this task from Needs Analysis to Upcoming on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Oct 18 2022, 4:33 PM
LGoto set the point value for this task to 1.Oct 18 2022, 5:00 PM
Jdlrobson edited projects, added Web-Team-Backlog (Needs Prioritization (Tech)); removed Web-Team-Backlog (Kanbanana-2022-23-Q2).Oct 18 2022, 5:39 PM
Jdlrobson subscribed.Oct 18 2022, 5:48 PM

See also T310004

Jdlrobson moved this task from Incoming to Deployment on the Desktop Improvements (Vector 2022) board.Oct 18 2022, 5:54 PM
Jdlrobson moved this task from Backlog to Future Unplanned on the Web-Team-Backlog (Needs Prioritization (Tech)) board.Oct 24 2022, 9:39 PM
Jdlrobson moved this task from Future Unplanned to Consolidate frontend code approaches in Minerva and Vector on the Web-Team-Backlog (Needs Prioritization (Tech)) board.Oct 26 2022, 10:10 PM
Jdlrobson added a comment.Oct 26 2022, 11:12 PM

https://doc.wikimedia.org/mediawiki-skins-Vector/master/js/ui/?path=/story/icon-and-buttons--button is pretty valuable to me to make sure Codex and mediawiki UI are evolving together. For me, consolidating the implementations of these 2 would be a precursor to removing storybook altogether.

gerritbot added a comment.Oct 27 2022, 12:39 AM

Change 838233 had a related patch set uploaded (by Jdlrobson; author: Bernard Wang):

[mediawiki/skins/Vector@master] [WIP] Split up Menu.template, restrict decoratePortletData to legacy Vector

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

gerritbot added a project: Patch-For-Review.Oct 27 2022, 12:39 AM
gerritbot added a comment.Nov 2 2022, 10:00 PM

Change 838233 merged by jenkins-bot:

[mediawiki/skins/Vector@master] [Technical] Split up Menu.template, restrict decoratePortletData to legacy Vector

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

Jdlrobson renamed this task from [Dev cleanup] Remove storybook from Vector to [Dev cleanup] Remove broken storybook from Vector.Nov 2 2022, 10:00 PM
Jdlrobson updated the task description. (Show Details)
Maintenance_bot removed a project: Patch-For-Review.Nov 2 2022, 10:29 PM
Jdlrobson removed the point value for this task.Feb 8 2023, 8:12 PM
Jdlrobson edited projects, added Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 4); removed Web-Team-Backlog (Needs Prioritization (Tech)).

This is tech debt that is causing confusion in other teams (I had a question about it from DST) so suggest we look to remove this soon

Jdlrobson updated the task description. (Show Details)Feb 8 2023, 8:17 PM
Jdlrobson triaged this task as Medium priority.Feb 16 2023, 6:39 PM
LGoto set the point value for this task to 2.Feb 16 2023, 6:55 PM
LGoto moved this task from Incoming to Ready for Development on the Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 4) board.
bwang updated the task description. (Show Details)Feb 16 2023, 6:55 PM
bwang removed the point value for this task.
Jdlrobson set the point value for this task to 2.Feb 22 2023, 9:04 PM
LGoto removed a project: Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 4).Feb 24 2023, 6:47 PM
Jdlrobson raised the priority of this task from Medium to High.Mar 13 2023, 11:34 PM
Jdlrobson added a subscriber: ovasileva.

@ovasileva this is continuing to cause confusion. I just reviewed a patch which made unnecessary changes so presumably took longer to fix than it should have done. This is trivial to fix and seems to be wasting us time each sprint.

Jdlrobson added a project: Web-Team-Backlog.Mar 13 2023, 11:34 PM
Jdlrobson moved this task from Incoming to Current Quarter on the Web-Team-Backlog board.Mar 15 2023, 5:39 PM
Jdlrobson renamed this task from [Dev cleanup] Remove broken storybook from Vector to [Dev cleanup] Remove broken storybook and jsdoc from Vector.Mar 22 2023, 4:27 PM
Jdlrobson updated the task description. (Show Details)
ovasileva edited projects, added Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 6); removed Web-Team-Backlog.Mar 27 2023, 3:13 PM
ovasileva moved this task from Incoming to Ready for Development on the Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 6) board.Mar 27 2023, 5:20 PM
bwang moved this task from Ready for Development to Doing on the Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 6) board.Mar 29 2023, 8:51 PM
bwang claimed this task.Mar 29 2023, 9:31 PM
bwang removed bwang as the assignee of this task.Mar 30 2023, 6:12 PM
bwang moved this task from Doing to Code Review on the Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 6) board.
• nray claimed this task.Mar 30 2023, 9:03 PM
gerritbot added a comment.Mar 30 2023, 9:33 PM

Change 904583 had a related patch set uploaded (by Bernard Wang; author: Bernard Wang):

[mediawiki/skins/Vector@master] Remove Storybook and jsdoc its dependencies

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

gerritbot added a project: Patch-For-Review.Mar 30 2023, 9:33 PM
gerritbot added a comment.Mar 31 2023, 4:07 PM

Change 904825 had a related patch set uploaded (by Bernard Wang; author: Bernard Wang):

[integration/config@master] Remove docs from Vector CI

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

Jdlrobson moved this task from Code Review to Blocked on Others on the Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 6) board.Mar 31 2023, 5:53 PM
Jdlrobson updated Other Assignee, added: bwang.
gerritbot added a comment.Apr 4 2023, 10:00 PM

Change 904583 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Remove Storybook and jsdoc and its dependencies

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

Jdlrobson reassigned this task from • nray to ovasileva.Apr 4 2023, 10:06 PM
Jdlrobson moved this task from Blocked on Others to Ready for Signoff on the Web-Team-Backlog (Web Team FY2022-23 Q3 Sprint 6) board.
Jdlrobson added a subscriber: • nray.
ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.4; 2023-04-10).Apr 5 2023, 1:00 AM
gerritbot added a comment.Apr 5 2023, 5:05 PM

Change 904825 abandoned by Bernard Wang:

[integration/config@master] Remove docs from Vector CI

Reason:

Chatted with Jon, decided it wasnt necessary to remove this template right now

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

Maintenance_bot removed a project: Patch-For-Review.Apr 5 2023, 5:12 PM
Jdlrobson reassigned this task from ovasileva to Jdrewniak.Apr 6 2023, 4:36 PM
Jdlrobson closed this task as Resolved.Apr 12 2023, 5:13 PM
Jdlrobson mentioned this in T334613: [Follow up] Discuss and document in our dev notes why storybook didn't work out for Vector and Minerva.

Captured sign off steps in T334613

Jdlrobson updated the task description. (Show Details)Apr 12 2023, 5:14 PM
gerritbot added a comment.Sep 29 2023, 12:18 AM

Change 961959 had a related patch set uploaded (by Jforrester; author: Bernard Wang):

[mediawiki/skins/Vector@REL1_39] Remove Storybook and jsdoc and its dependencies

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

gerritbot added a project: Patch-For-Review.Sep 29 2023, 12:18 AM
gerritbot added a comment.Sep 29 2023, 12:21 AM

Change 961959 merged by jenkins-bot:

[mediawiki/skins/Vector@REL1_39] Remove Storybook and jsdoc and its dependencies

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

Maintenance_bot removed a project: Patch-For-Review.Sep 29 2023, 12:30 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits