Page MenuHomePhabricator

Publish MobileFrontend JS Documentation
Closed, ResolvedPublic

Description

We want our documentation published on https://doc.wikimedia.org/


Published: https://doc.wikimedia.org/MobileFrontend/master/

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 3:52 AM
bzimport set Reference to bz72794.

bingle-admin wrote:

Prioritization and scheduling of this bug is tracked on Trello card https://trello.com/c/o79gX3x5

Change 181693 had a related patch set uploaded (by Jdlrobson):
Publish documentation for MobileFrontend

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

Patch-For-Review

We have too many different ways to generate documentation. Each time we end up having to create yet another job and Jon patch is an illustration ( https://gerrit.wikimedia.org/r/#/c/181693 ). I don't think copy pasting will scale very nicely and it makes it way too complicated (imho) for developers to configure the documentation job.

I have filled T88999 to propose we establish a conventional command to generate doc. This way all repositories will be able to share the same Jenkins job template which will make it trivial to configure.

That is merely to avoid pilling more tech debt on top of the existing debt. I have mailed wikitech-l about a doc entry point ( T88999 ). Will go with make docs unless the mob comes with something better.

hashar renamed this task from Publish our JS Documentation to Publish MobileFrontend JS Documentation.Feb 10 2015, 6:10 PM

After a week on wikitech-l and barely any comment, make docs is adopted as an entry point to generate documentation. Could you provide a /makefile with a docs target please? I am working on the Jenkins job template.

@hashar: We already have a Makefile [1] with a "docs" target :)

Thanks for your work!

[1] https://github.com/wikimedia/mediawiki-extensions-MobileFrontend/blob/master/Makefile#L44

Change 191046 had a related patch set uploaded (by Hashar):
Docs jobs for MobileFrontend

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

Patch-For-Review

I made a first pass job that clones mediawiki/core and MobileFrontend under /src/ then do:

export MW_INSTALL_PATH=/src
cd /src/extensions/MobileFrontend
make docs

Since the documentation refers to mediawiki/core ( I wish we could drop that dependency).

Anyway the script fails because it expects a working installation on port 8080. Apparently to fetch some styles:

curl -sG "http://localhost:8080/w/load.php?modules=skins.minerva.chrome.styles|skins.minerva.content.styles|skins.minerva.drawers.styles|mobile.toast.styles|mobile.stable.styles|mobile.overlays|mobile.overlays.beta|mobile.pagelist.styles&only=styles" > /tmp/tmp.OuDHiAUd6b

I guess you will want to compile the less stylesheets and then refer to the resulting css directly.

An example build is https://integration.wikimedia.org/ci/job/mwext-MobileFrontend-mwextdocs/2/console

Hey! Just got back from vacation so catching up on all this.
Looks good but I can't see the output... maybe we should organise a hangout to wrap this up? Thoughts (Feel free to setup a meeting with me if yes - I can make myself available whenever to wrap this up)?

In terms of the css I'm not sure what to do about that... apart from removing this from the make docs command. We can't easily generate them outside MediaWiki... if we can do it via php I'm not sure how best and reliably we can do that.

(If we set MEDIAWIKI_LOAD_URL = http://en.m.wikipedia.beta.wmflabs.org/w/load.php this will work - is that an option or does the script not have access to the outside world?)

moving to eng backlog, as hasn't been touched in awhile.

Change 181693 abandoned by Jdlrobson:
Publish documentation for MobileFrontend

Reason:
See https://gerrit.wikimedia.org/r/#/c/191046/

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

Change 219449 had a related patch set uploaded (by Krinkle):
Create mwext-MobileFrontend-publish

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

Change 219449 merged by jenkins-bot:
Create mwext-MobileFrontend-publish

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

Krinkle triaged this task as Medium priority.
Krinkle removed a project: Patch-For-Review.
Krinkle removed a subscriber: gerritbot.

Change 219591 had a related patch set uploaded (by Florianschmidtwelzow):
Add MobileFrontend js docs to doc.wikimedia.org

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

Change 219591 merged by jenkins-bot:
Add MobileFrontend js docs to doc.wikimedia.org

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

Change 191046 abandoned by JanZerebecki:
Docs jobs for MobileFrontend

Reason:
Publishing docs for the MobileFrontend was some time ago implemented in other patches.

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