MDN/Projects/Content/MDN Content Kits: Difference between revisions

< MDN‎ | Projects‎ | Content
(Changed name of the project to "MDN Content Kits")
(Added a l10n.js Content Kit)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=MDN Content Kits=
=MDN Content Kits=
This project consists of technical content to support local developer communities, to be used as a focal point for developer meetups and education. Each "kit" contains a collection of resources about a particular topic related to web development or web app development, such as Web APIs, useful libraries, or developer tools.  
MDN Content Kits are a set of technical content to support local developer communities, to be used as a focal point for developer meetups and education. Each "kit" contains a collection of resources about a particular topic related to web development or web app development, such as Web APIs, useful libraries, or developer tools. A [https://developer.mozilla.org/en-US/Learn/Content_Kits current list of MDN Content Kits] is maintained on MDN.
 
The goal of MDN Content Kits is to provide community members the information they need, in one place, on specific technologies of interest to other developers in their communities. The kits will provide a base for community members to host ongoing developer meetups and/or present to other developers on these topics. By doing so, we hope to grow developer engagement with Mozilla at a local level, and increase standards-based web development globally. Kits will initially feature technologies appropriate for intermediate and advanced-level developers, although as the program matures there will be opportunity to expand to more beginner-level kits.
 
Goals
* 3 new kits per quarter
* 2 meetups in Q1 2015, then increasing each quarter afterwards (goal is 10 globally in Q4)


* [https://docs.google.com/a/mozilla.com/document/d/1hGCSt7BdlqqLYUsohfKXg0Q8oQq5ugsoqifDlu6OH9s/edit Project Evaluation document]
* [https://docs.google.com/a/mozilla.com/document/d/1hGCSt7BdlqqLYUsohfKXg0Q8oQq5ugsoqifDlu6OH9s/edit Project Evaluation document]


==What's in a Content Kit?==
==What's in a Content Kit?==
A content kit covers an API, tool, or technique of interest to Web/app developers and of strategic value to Mozilla. Elements of a kit can include:
A content kit is a set of resources that lets a presenter or teacher talk about an API, tool, or technique of interest to Web developers and of strategic value to Mozilla. (If you change this list, you also need to update the [https://github.com/mdn/content-kit-template MDN Content Kit Template on github] that content kit creators use or it will have no affect!) Elements of a kit can include:  
 
* Educational materials for the presenter
** Presentation notes of points to be covered in presenting the topic
** A video or live demo showing the API/tool/technique
** A video recording of the presentation materials being used
** An instructional video of how to give the presentation or demo
** Difficult questions the presenter might get along with answers
* Supporting materials for the presentation, class or meetup might include:
** Presentation materials
** A script for demoing the project
** Questions or points for further discussion
** Activities for engaging with the topic (e.g., “Change the demo project so it does X. How do you handle Y?”)
** Video of the demo that can be used offline
* Reference materials
** Link to the code project that can be used to demo the API/tool/technique
** Link to a Hacks post on this topic
** Links to relevant MDN articles
 
'''Examples:'''
*See the [https://github.com/mdn/content-kit-template Template for MDN Content Kit] project on Github for a prototype structure for content kits.
*Existing content kits are listed on [https://developer.mozilla.org/en-US/Learn/Content_Kits MDN] and currently include:
**[http://mdn.github.io/beginning-programming-content-kit/ Beginning Programming Content Kit]
**[https://gist.github.com/callahad/1d0885dd70b157c3978e#file-valence-content-kit-md Valence Content Kit]
**[https://github.com/sole/ck-node-firefox node-firefox Content Kit]
**[https://github.com/chrisdavidmills/html5-captions-and-subtitles-content-kit HTML5 Captions & Subtitles Content Kit]
**[http://codingfree.github.io/l10n-content-kit l10n.js Content Kit]
*See the [https://gist.github.com/autonome/f4213d648afcb090b6e2 Thing Content Kit] another prototype structure for content kits
*[http://mozilla.github.io/webmaker-curriculum/WebLiteracyBasics-I/ WebMaker Literacy Basics] a landing page for Web Literacy learning materials.
 
==Request and Development Process==
Content Kits are currently being prototyped. Once a final set of required kit elements and templates are developed, the request and prioritization process will be fully implemented. This process will be formalized in March & April of 2015.
 
===Proposing a Topic===
 
Topics can be requested or proposed by the broader the Mozilla community, including volunteers, meetup hosts, technical evangelists, engineering, and others. Potential topics for content kits are currently tracked and discussed in [https://devengage.etherpad.mozilla.org/DevMeetupTopics this etherpad] as well as on the [https://lists.mozilla.org/listinfo/mdn mdn] mailing list.
 
Topics will prioritized based on inclusion in product releases, standards recommendation, specific marketing or community goal, and volume of requests for the topic. If you'd like to implement a content kit on a particular topic, please bring it up on the mailing list before starting, to avoid duplication with other efforts, and so you can get advice on implementing a kit (since the format is still being prototyped).
 
Once a topic has been discussed and there is general consensus that it should be implemented as a kit, it is moved to a [https://docs.google.com/a/mozilla.com/spreadsheets/d/1Zpmqu6rRHsMuJ8x4vm0uoA3PB2JhFFsf15Yw3_-neHQ/edit#gid=0 Google Spreadsheet] that is reviewed monthly in the MDN/Technical evangelism weekly meeting. Beginning in April 2015, we will hold monthly, open meetings to discuss which kits to prioritize.
 


===Priorities===


'''Required:'''
{{#widget:Google Spreadsheet
(details subject to change)
|key=1Zpmqu6rRHsMuJ8x4vm0uoA3PB2JhFFsf15Yw3_-neHQ
* A script for demoing the project
|width=700
* Link to a code project that can be used to demo the API/tool/technique
|height=800
* Presentation notes (optionally including slides) of points to be covered in presenting the topic
}}


'''Optional:'''
==Who Can Build a Kit==
* Link to a Hacks post on this topic
Kits can be built by anyone, and we encourage people to suggest and build kits.  
* Link to a [[MDN/Projects/Content/Videos|video]] or live demo showing the API/tool/technique
* Questions or points for further discussion
* Links to relevant MDN articles
* Activities for engaging with the topic (e.g., “Change the demo project so it does X. How do you handle Y?”)


See the [https://github.com/mdn/content-kits MDN Content Kits] project on Github for a prototype structure for content kits.
To build a kit, please see visit the [https://github.com/mdn/content-kit-template Template MDN Content Kit] on Github.


==Topics==
Submitted kits will be reviewed by subject matter experts to make sure they are technologically correct, contain all the required elements, and use the correct templates and repositories. All Content Kits must be built to facilitate localization, which will further enable local communities to use the kits to engage with developers. Specifically, please use text-based file formats such as HTML and SVG, and enable subtitles on videos, to support localization.
Potential topics for content kits are being discussed in [https://devengage.etherpad.mozilla.org/DevMeetupTopics this etherpad].


==Using a content kit for a meetup==
In addition to community-built kits, Mozilla paid staff will build and release at least 1 kit per month, based on the priorities decided in the meetings.
Here's how you can use the contents of a content kit in a meetup:


===Prior to a meetup===
==Using Content Kits==
# Review the content package and all supporting materials, including relevant MDN articles.
See the [https://developer.mozilla.org/en-US/Learn/Content_Kits list of MDN Content Kits and directions] on MDN.
# Download the demo project and play with it until they feel comfortable demoing it.
# Download the video, so you can play it locally if all else fails.
===During the meetup===
# Present the topic, including a live demo (or recorded, if necessary).
# Lead the group in a discussion of the topic, or an activity with the demo project.
===After the meetup===
# Submit issues for any problems you encountered with the kit.
# Submit pull requests for any changes you made to the kit.

Latest revision as of 16:22, 22 June 2015

MDN Content Kits

MDN Content Kits are a set of technical content to support local developer communities, to be used as a focal point for developer meetups and education. Each "kit" contains a collection of resources about a particular topic related to web development or web app development, such as Web APIs, useful libraries, or developer tools. A current list of MDN Content Kits is maintained on MDN.

The goal of MDN Content Kits is to provide community members the information they need, in one place, on specific technologies of interest to other developers in their communities. The kits will provide a base for community members to host ongoing developer meetups and/or present to other developers on these topics. By doing so, we hope to grow developer engagement with Mozilla at a local level, and increase standards-based web development globally. Kits will initially feature technologies appropriate for intermediate and advanced-level developers, although as the program matures there will be opportunity to expand to more beginner-level kits.

Goals

  • 3 new kits per quarter
  • 2 meetups in Q1 2015, then increasing each quarter afterwards (goal is 10 globally in Q4)

What's in a Content Kit?

A content kit is a set of resources that lets a presenter or teacher talk about an API, tool, or technique of interest to Web developers and of strategic value to Mozilla. (If you change this list, you also need to update the MDN Content Kit Template on github that content kit creators use or it will have no affect!) Elements of a kit can include:

  • Educational materials for the presenter
    • Presentation notes of points to be covered in presenting the topic
    • A video or live demo showing the API/tool/technique
    • A video recording of the presentation materials being used
    • An instructional video of how to give the presentation or demo
    • Difficult questions the presenter might get along with answers
  • Supporting materials for the presentation, class or meetup might include:
    • Presentation materials
    • A script for demoing the project
    • Questions or points for further discussion
    • Activities for engaging with the topic (e.g., “Change the demo project so it does X. How do you handle Y?”)
    • Video of the demo that can be used offline
  • Reference materials
    • Link to the code project that can be used to demo the API/tool/technique
    • Link to a Hacks post on this topic
    • Links to relevant MDN articles

Examples:

Request and Development Process

Content Kits are currently being prototyped. Once a final set of required kit elements and templates are developed, the request and prioritization process will be fully implemented. This process will be formalized in March & April of 2015.

Proposing a Topic

Topics can be requested or proposed by the broader the Mozilla community, including volunteers, meetup hosts, technical evangelists, engineering, and others. Potential topics for content kits are currently tracked and discussed in this etherpad as well as on the mdn mailing list.

Topics will prioritized based on inclusion in product releases, standards recommendation, specific marketing or community goal, and volume of requests for the topic. If you'd like to implement a content kit on a particular topic, please bring it up on the mailing list before starting, to avoid duplication with other efforts, and so you can get advice on implementing a kit (since the format is still being prototyped).

Once a topic has been discussed and there is general consensus that it should be implemented as a kit, it is moved to a Google Spreadsheet that is reviewed monthly in the MDN/Technical evangelism weekly meeting. Beginning in April 2015, we will hold monthly, open meetings to discuss which kits to prioritize.


Priorities

Who Can Build a Kit

Kits can be built by anyone, and we encourage people to suggest and build kits.

To build a kit, please see visit the Template MDN Content Kit on Github.

Submitted kits will be reviewed by subject matter experts to make sure they are technologically correct, contain all the required elements, and use the correct templates and repositories. All Content Kits must be built to facilitate localization, which will further enable local communities to use the kits to engage with developers. Specifically, please use text-based file formats such as HTML and SVG, and enable subtitles on videos, to support localization.

In addition to community-built kits, Mozilla paid staff will build and release at least 1 kit per month, based on the priorities decided in the meetings.

Using Content Kits

See the list of MDN Content Kits and directions on MDN.