Page MenuHomePhabricator

Publish frontend docs to doc.wikimedia.org/
Closed, ResolvedPublic

Description

This task is to publish the vitepress docs under documentation/frontend to the wikimedia.org documentation. It will help making the extension frontend specific docs broadly available and also ease the design review process of the new Vue components developed within.

Event Timeline

Change 888022 had a related patch set uploaded (by Kosta Harlan; author: Kosta Harlan):

[integration/config@master] zuul: Add GrowthExperiments to extension-javascript-documentation

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

Change 888206 had a related patch set uploaded (by Sergio Gimeno; author: Sergio Gimeno):

[mediawiki/extensions/GrowthExperiments@master] Frontend docs: add build command in the root of the repository

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

Change 889984 had a related patch set uploaded (by Sergio Gimeno; author: Sergio Gimeno):

[mediawiki/extensions/GrowthExperiments@master] Frontend docs: fix typo in npm command

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

The vitepress build docs command fails with the following output:

import { CdxDialog, CdxButton } from "@wikimedia/codex";
                    ^^^^^^^^^
SyntaxError: Named export 'CdxButton' not found. The requested module '@wikimedia/codex' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

import pkg from '@wikimedia/codex';
const { CdxDialog, CdxButton } = pkg;

Commented in T294993#8624960, see if this can be solved on the Codex packages rather than writing code in an unconventional way.

Change 889984 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Frontend docs: fix typo in npm command

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

Sgs changed the task status from Open to In Progress.Feb 21 2023, 11:33 AM

Change 888206 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Frontend docs: add build command in the root of the repository

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

Change 888022 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/extensions/GrowthExperiments] Add JS doc build/publish jobs

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

Mentioned in SAL (#wikimedia-releng) [2023-02-21T16:04:47Z] <James_F> Zuul: [mediawiki/extensions/GrowthExperiments] Add JS doc build/publish jobs T329034

Change 891255 had a related patch set uploaded (by Kosta Harlan; author: Kosta Harlan):

[integration/docroot@master] doc: Add GrowthExperiments to MediaWiki components

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

kostajh updated the task description. (Show Details)
kostajh awarded a token.
kostajh subscribed.

The docs are now published in https://doc.wikimedia.org/GrowthExperiments/

Nice work!

Change 891255 merged by jenkins-bot:

[integration/docroot@master] doc: Add GrowthExperiments to MediaWiki components

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

Mentioned in SAL (#wikimedia-operations) [2023-02-22T16:22:59Z] <hashar@deploy1002> Started deploy [integration/docroot@b32e023]: doc: Add GrowthExperiments to MediaWiki components - T329034

Mentioned in SAL (#wikimedia-operations) [2023-02-22T16:23:07Z] <hashar@deploy1002> Finished deploy [integration/docroot@b32e023]: doc: Add GrowthExperiments to MediaWiki components - T329034 (duration: 00m 07s)