Publish WVUI documentation to doc.wikimedia.org
Closed, ResolvedPublic
Actions

Description

T253348 added Storybook for streamlining development and generating documentation. We'll likely have even more docs. This task covers the work to publish any generated documentation to doc.wikimedia.org.

Acceptance criteria

Documentation generation for distribution on doc.wikimedia.org is build by running npm run docs:ui which is called by npm docs and tested on commit.

Details

Subject	Repo	Branch	Lines +/-
Temporarily drop source map documentation generation from `npm doc`	wvui	master	+1 -1
Publish wvui documentation to docs.wikimedia.org	integration/config	master	+1 -0
Add `npm doc` command	wvui	master	+1 -0

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	Jdlrobson	T249298 [Epic] Establish initial project scaffolding for Vue.js search iterations
Resolved	Jdlrobson	T255678 Publish WVUI documentation to doc.wikimedia.org
Resolved	• nnikkhoui	T253364 Move Vue.js search development over to Gerrit
Resolved	None	T253357 Name the Vue.js component library
Resolved	• nnikkhoui	T254837 Create a Docker configuration for building WVUI for Vue.js search

Event Timeline

• Niedzielski created this task.Jun 17 2020, 2:07 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 17 2020, 2:07 PM

• Niedzielski added a subtask: T253364: Move Vue.js search development over to Gerrit.Jun 17 2020, 2:07 PM

• Niedzielski mentioned this in T253348: Add Storybook to Vue.js search.

• Niedzielski moved this task from Backlog to Analysis on the Design-Systems-team-20200324-20220422 (Vue.js Search Experience (Vector modern)) board.Jun 17 2020, 2:23 PM

Abbe98 subscribed.Jul 2 2020, 4:10 PM

Volker_E added a project: WVUI.Aug 4 2020, 6:55 PM

• nnikkhoui closed subtask T253364: Move Vue.js search development over to Gerrit as Resolved.Sep 8 2020, 5:49 PM

@nnikkhoui, this task is lower priority than the other build tasks but still important work that might be in your wheelhouse.

• Niedzielski mentioned this in T254837: Create a Docker configuration for building WVUI for Vue.js search.Sep 30 2020, 9:34 PM

Jdlrobson mentioned this in T249298: [Epic] Establish initial project scaffolding for Vue.js search iterations.Dec 2 2020, 5:50 PM

Jdlrobson added a project: Web-Team-Backlog (Kanbanana-FY-2020-21).Dec 2 2020, 6:24 PM

Change 644887 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[wvui@master] Add npm doc command

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

gerritbot added a project: Patch-For-Review.Dec 2 2020, 6:28 PM

Change 644888 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[integration/config@master] Publish wvui documentation to docs.wikimedia.org

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

Change 644887 merged by jenkins-bot:
[wvui@master] Add npm doc command

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

Change 644888 merged by jenkins-bot:
[integration/config@master] Publish wvui documentation to docs.wikimedia.org

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

Maintenance_bot removed a project: Patch-For-Review.Dec 2 2020, 10:11 PM

Change 644938 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[wvui@master] Temporarily drop source map documentation generation from npm doc

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

gerritbot added a project: Patch-For-Review.Dec 2 2020, 10:36 PM

Change 644938 merged by jenkins-bot:
[wvui@master] Temporarily drop source map documentation generation from npm doc

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

Jdlrobson moved this task from Needs Analysis to Code Review on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Dec 3 2020, 8:21 PM