MDN/Projects/Content/MDN Content Kits

From MozillaWiki
Jump to navigation Jump to search

Developer Topic in a Box

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.

What's in a Topic Box?

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:


Required:

  • 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 DevTopicInABox project on Github for a template structure for topic boxes.

Topics

Potential topics for topic boxes are being discussed in this etherpad.

Using a topic box for a meetup

Here's how you can use the contents of a topic box 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 box.
  2. Submit pull requests for any changes you made to the box.