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

From MozillaWiki
< MDN‎ | Projects‎ | Content
Jump to navigation Jump to search
m (Jswisher moved page MDN/Projects/Content/TopicInABox to MDN/Projects/Content/MDN Content Kits: Decided on a new name)
(Changed name of the project to "MDN Content Kits")
Line 1: Line 1:
=Developer Topic in a Box=
=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 "box" 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.  
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.  


* [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 Topic Box?==
==What's in a Content Kit?==
A topic box covers an API, tool, or technique of interest to Web/app developers and of strategic value to Mozilla. Elements of a box can include:
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:




Required:
'''Required:'''
(details subject to change)
* A script for demoing the project
* A script for demoing the project
* Link to a code project that can be used to demo the API/tool/technique
* Link to a code project that can be used to demo the API/tool/technique
* Presentation notes (optionally including slides) of points to be covered in presenting the topic
* Presentation notes (optionally including slides) of points to be covered in presenting the topic


Optional:  
'''Optional:'''
* Link to a Hacks post on this topic
* Link to a Hacks post on this topic
* Link to a [[MDN/Projects/Content/Videos|video]] or live demo showing the API/tool/technique
* Link to a [[MDN/Projects/Content/Videos|video]] or live demo showing the API/tool/technique
Line 20: Line 21:
* Activities for engaging with the topic (e.g., “Change the demo project so it does X. How do you handle Y?”)
* 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/jmswisher/DevTopicInABox DevTopicInABox] project on Github for a template structure for topic boxes.
See the [https://github.com/mdn/content-kits MDN Content Kits] project on Github for a prototype structure for content kits.


==Topics==
==Topics==
Potential topics for topic boxes are being discussed in [https://devengage.etherpad.mozilla.org/DevMeetupTopics this etherpad].
Potential topics for content kits are being discussed in [https://devengage.etherpad.mozilla.org/DevMeetupTopics this etherpad].


==Using a topic box for a meetup==
==Using a content kit for a meetup==
Here's how you can use the contents of a topic box in a meetup:
Here's how you can use the contents of a content kit in a meetup:


===Prior to a meetup===
===Prior to a meetup===
Line 36: Line 37:
# Lead the group in a discussion of the topic, or an activity with the demo project.
# Lead the group in a discussion of the topic, or an activity with the demo project.
===After the meetup===
===After the meetup===
# Submit issues for any problems you encountered with the box.
# Submit issues for any problems you encountered with the kit.
# Submit pull requests for any changes you made to the box.
# Submit pull requests for any changes you made to the kit.

Revision as of 21:47, 12 February 2015

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.

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:


Required: (details subject to change)

  • A script for demoing the project
  • Link to a code project that can be used to demo the API/tool/technique
  • Presentation notes (optionally including slides) of points to be covered in presenting the topic

Optional:

  • Link to a Hacks post on this topic
  • Link to a 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 MDN Content Kits project on Github for a prototype structure for content kits.

Topics

Potential topics for content kits are being discussed in this etherpad.

Using a content kit for a meetup

Here's how you can use the contents of a content kit in a meetup:

Prior to a meetup

  1. Review the content package and all supporting materials, including relevant MDN articles.
  2. Download the demo project and play with it until they feel comfortable demoing it.
  3. Download the video, so you can play it locally if all else fails.

During the meetup

  1. Present the topic, including a live demo (or recorded, if necessary).
  2. Lead the group in a discussion of the topic, or an activity with the demo project.

After the meetup

  1. Submit issues for any problems you encountered with the kit.
  2. Submit pull requests for any changes you made to the kit.