866426 - I'd like to have a way to upload example code and refer to it from MDN pages

Status: RESOLVED INVALID

(developer.mozilla.org Graveyard :: General, defect)

Description

[Will Bamberg [:wbamberg]]

What problems would this solve?
===============================
I'm writing a walkthrough of debugging a web app. For people to be able to follow along, it would be great to be able to provide a link to various versions of the web app.

Initially I tried just uploading a zip of the app in each stage, but I can't do that (for security reasons, I guess).

At the moment I've just checked the files into GitHub and linked to them there. Is this the best approach, or do we want to enable people to upload these things to MDN's servers, and link to them there?

Who would use this?
===================
People writing documentation.

What would users see?
=====================
They'd be able to download example code.

What would users do? What would happen as a result?
===================================================
They'd be able to play along with walkthrough tutorials.

Is there anything else we should know?
======================================
No.

Comment 1

[Eric Shepherd [:sheppy]]

We probably should offer a permission level at which people are allowed to upload zip files in addition to the usual things.

Comment 2

[Janet Swisher]

What's the user interaction for readers? Do they download and load the files into their favorite editor? Or open a project in an online editor? Or?

Comment 3

[Will Bamberg [:wbamberg]]

I think in this case (https://developer.mozilla.org/en-US/docs/Tools/Firefox_OS_Simulator/Simulator_Walkthrough) it would be to download the files locally, then add the manifest to the Simmulator.

Comment 4

[John Karahalis [:openjck]]

Sounds like we could solve this problem by just expanding the "upload zip" permission, as Sheppy points out in comment 1.

I think we do need some clarify on user interaction on the management side, though. Who would grant the permission? How and where would they grant it? Should the permission-giver grant the permission specifically, or should the permission be bundled up in a "group" or "team", which the permission-giver assigns instead?

Les has been working on a permission management infrastructure with bug 677814, so he might have some insight on this.

Comment 5

[Les Orchard [:lorchard]]

For attachments, we accept only these mime-types, per direction from the security team:

image/gif image/jpeg image/png image/svg+xml text/html image/vnd.adobe.photoshop

Maybe we can look into implementing an expanded upload permission that makes a user exempt from the upload whitelist.

Before bug 677814, this permission would need to be granted on a user-by-user basis, and apply globally across the site.

When we have bug 677814 released, we'll have teams & per-team roles as a structure to manage permissions by section of the site.

Of course, having said all the above... The Demo Studio *does* accept zip uploads, the *contents* of which are scanned against a whitelist. We might want to consider improvements to make that useful for things like this. For example, we could add a way to view source inside a demo with syntax highlighting, and refer to demos more easily from the wiki

Comment 6

[Eric Shepherd [:sheppy]]

What would really be nice is if the Simulator had a feature whereby we could send it a link to grab and install. Then we could just have a "Install into Firefox OS Simulator" button.