MDN/Projects/Content/MDN Content Kits: Difference between revisions
(adding prioritization process and other planning details) |
|||
| Line 6: | Line 6: | ||
==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 developers and of strategic value to Mozilla. Elements of a kit can include: | A content kit covers an API, tool, or technique of interest to Web developers and of strategic value to Mozilla. Elements of a kit can include: | ||
'''Required:''' | '''Required:''' | ||
| Line 12: | Line 11: | ||
* 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 | * Slides for presenting | ||
* Presentation notes 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 | * Link to a video or live demo showing the API/tool/technique | ||
* Questions or points for further discussion | * Questions or points for further discussion | ||
* Links to relevant MDN articles | * Links to relevant MDN articles | ||
| Line 23: | Line 23: | ||
See the [https://github.com/mdn/content-kits MDN Content Kits] project on Github for a prototype structure for content kits. | See the [https://github.com/mdn/content-kits MDN Content Kits] project on Github for a prototype structure for content kits. | ||
==Content | ==Request and Development Process== | ||
Topics | 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. | ||
===Requesting a Topic=== | |||
Topics can be requested by the broader the Mozilla community, including volunteers, meetup hosts, technical evangelists, engineering, and others. Potential topics for content kits are currently requested and discussed in [https://devengage.etherpad.mozilla.org/DevMeetupTopics 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. | |||
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=== | |||
{{#widget:Google Spreadsheet | |||
|key=1Zpmqu6rRHsMuJ8x4vm0uoA3PB2JhFFsf15Yw3_-neHQ | |||
|width=700 | |||
|height=800 | |||
}} | |||
==Who Can Build a Kit== | |||
Kits can be built by anyone, and we encourage people to suggest and build kits. 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. | |||
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 a content kit for a meetup== | ==Using Content Kits== | ||
===Using a content kit for a meetup=== | |||
Here's how you can use the elements of a content kit in a meetup: | Here's how you can use the elements of a content kit in a meetup: | ||
===Prior to a meetup=== | ====Prior to a meetup==== | ||
# Review the content kit and all supporting materials, including relevant MDN articles. | # Review the content kit and all supporting materials, including relevant MDN articles. | ||
# Download the demo project and play with it until you feel comfortable demoing it. | # Download the demo project and play with it until you feel comfortable demoing it. | ||
# Download the video, so you can play it locally if all else fails. | # Download the video, so you can play it locally if all else fails. | ||
===During the meetup=== | ====During the meetup==== | ||
# Present the topic, including a live demo (or recorded, if necessary). | # 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. | # 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 kit. | # Submit issues for any problems you encountered with the kit. | ||
# Submit pull requests for any changes you made to the kit. | # Submit pull requests for any changes you made to the kit. | ||
Revision as of 02:06, 18 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 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
- Slides for presenting
- Presentation notes 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.
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.
Requesting a Topic
Topics can be requested by the broader the Mozilla community, including volunteers, meetup hosts, technical evangelists, engineering, and others. Potential topics for content kits are currently requested 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.
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. 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.
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
Using a content kit for a meetup
Here's how you can use the elements of a content kit in a meetup:
Prior to a meetup
- Review the content kit and all supporting materials, including relevant MDN articles.
- Download the demo project and play with it until you 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.