Last modified: 2014-08-19 14:35:04 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T62143, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 60143 - Provide a way to have a demo directory alongside the documentation on doc.wikimedia.org
Provide a way to have a demo directory alongside the documentation on doc.wik...
Status: NEW
Product: Wikimedia
Classification: Unclassified
Continuous integration (Other open bugs)
unspecified
All All
: Normal enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2014-01-16 19:32 UTC by James Forrester
Modified: 2014-08-19 14:35 UTC (History)
6 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description James Forrester 2014-01-16 19:32:19 UTC
The OOjs UI library has a useful demos directory, which shows off each of the widgets available. Similarly, VisualEditor also has a demos directory, and I imagine other projects do (or would if it became an established pattern.

It would be really great if we could somehow expose these alongside their projects' documentation, so we can point people to a living thing rather than telling them to checkout the repo and play. Something like…

https://doc.wikimedia.org/VisualEditor/master/
https://doc.wikimedia.org/VisualEditor/master/demos/

https://doc.wikimedia.org/VisualEditor/0.1.0/
https://doc.wikimedia.org/VisualEditor/0.1.0/demos/

https://doc.wikimedia.org/OOjs-UI/master/
https://doc.wikimedia.org/OOjs-UI/master/demos/

https://doc.wikimedia.org/OOjs-UI/1.0.6/
https://doc.wikimedia.org/OOjs-UI/1.0.6/demos/
Comment 1 Antoine "hashar" Musso (WMF) 2014-01-16 20:10:54 UTC
Do the demo require a server side backend or are they 100% executing in the browser?  If we need to serve content, that would need to be done on another server.  Else, it is "just" about enhancing the doc jobs to publish the demo to the document root.
Comment 2 James Forrester 2014-01-17 03:49:57 UTC
(In reply to comment #1)
> Do the demo require a server side backend or are they 100% executing in the
> browser?  If we need to serve content, that would need to be done on another
> server.  Else, it is "just" about enhancing the doc jobs to publish the demo
> to
> the document root.

Fully stand-alone client-side JS only, providing static files. Theoretically they could just be linked off beta's bits – e.g. http://bits.beta.wmflabs.org/static-master/extensions/VisualEditor/lib/ve/demos/ve/eventLogger.html – but this is ugly (and doesn't work for OOjs UI because it's only deployed in compiled form without demos).
Comment 3 spage 2014-01-25 07:38:47 UTC
This is similar to bug 58620.  Since the OOjs UI demos require nodejs/npm setup similar to building the KSS documentation, fixing this will require similar steps as hashar outlined in comment 1 there.

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links