├── demo
└── .gitkeep
├── css
├── .main.css.swp
├── .gitignore.swp
└── main.css
├── img
└── mdn_logo.png
├── README.md
├── index.html
└── LICENSE
/demo/.gitkeep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/css/.main.css.swp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mdn/content-kit-template/gh-pages/css/.main.css.swp
--------------------------------------------------------------------------------
/img/mdn_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mdn/content-kit-template/gh-pages/img/mdn_logo.png
--------------------------------------------------------------------------------
/css/.gitignore.swp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mdn/content-kit-template/gh-pages/css/.gitignore.swp
--------------------------------------------------------------------------------
/css/main.css:
--------------------------------------------------------------------------------
1 | body {
2 | margin: 10px;
3 | font-family: "Open Sans",sans-serif;
4 | line-height: 1.5;
5 | color: #4D4E53;
6 | }
7 |
8 | h1 {
9 | background-image: url('/img/mdn_logo.png');
10 | background-repeat: no-repeat;
11 | background-position: 0 0;
12 | background-size: 50px 50px;
13 | padding: 10px 0 0 0;
14 | height: 50px;
15 | }
16 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | # Content-kit-template
6 | To create a new MDN Content Kit, fork or clone this template.
7 |
8 | ## Instructions
9 | 1. Remember that you are creating the kit for the teacher or presenter. Speak to them. Make sure you give them everything they need to be successful.
10 | 1. Fork or clone this MDN Content Kit Template project.
11 | 1. Create your README - template below.
12 | 1. Create your index.html file.
13 | 1. Put all of your resources into the repo.
14 |
15 | # Things to include in your repo:
16 | 1. Readme - see example below
17 | 1. Version Number or Last Updated Date
18 | 1. Introduction/Summary
19 | 1. Key Points - what the presenter's audience will get
20 | 1. Reference Materials
21 | 1. Presentation Materials
22 | 1. Demo Materials
23 | 1. Presentation materials to include in your MDN Content Kit - These can be in your repo or you can link to them from your readme.
24 | 1. Slides - in an open, editable format. The more notes, the better.
25 | 1. Video of the materials being presented. This can be useful either for less experienced meetup groups to use or for presenters to use to learn how to give this presentation.
26 | 1. Demo materials.
27 | 1. Demo how to.
28 | 1. Demo trouble shooting.
29 | 1. Video or screencast of the demo being given. This is especially important if the presenter is not highly skilled or if the demo has to be given in front of a live audience or offline.
30 | 1. Exercises for the presenter's audience to practice using the material.
31 | 1. FAQs. Questions you'd expect the presenter to get and how to answer them.
32 | 1. Pictures/diagrams.
33 |
34 | # Include the following in your README.md file:
35 |
36 | This is the YourTopicName Content Kit. It contains everything you need to present/teach a one hour presentation on YourTopicName.
37 |
38 | To get started, visit [This project's index file.](index.html).
39 |
40 | You can get much more detailed instructions on writing a content kit from our [Making a new content kit guide](http://chrisdavidmills.github.io/content-kit-guide/).
41 |
42 | # Final steps:
43 |
44 | 1. Update the [list of kits on MDN](https://developer.mozilla.org/en-US/Learn/Content_kits) with a link to your new kit.
45 |
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
One sentence description of thing and its purpose.
14 |
15 |
16 | Technology level: is this technology well established or is it still experimental?
17 |
18 |
19 |
20 | For any issues, submit issues against LinkToGithubRepoHere.
21 |
22 |
23 |
Versioning information
24 |
25 |
Current as of Project 0.2.4, include the date of this kit's last significant update (not every commit will necessarily be significant.) Optionally, include some indication of what version of technology this kit supports if necessary, for example Python 2.7.x, or Node 0.9.x, if the above general description isn't detailed enough.
26 |
27 |
This content kit is published under the Mozilla Public License, version 2.0. (A fairly permissive license, compatible with MDN, which allows good reuse.) You can substitute it for another suitable license if you wish.
28 |
29 |
What should the presenter have?
30 |
31 |
32 |
What hardware and software will the presenter need?
33 |
For example
34 |
35 |
Modern browsers, text editor?
36 |
Python or Node installed?
37 |
Instructions for projecting your device's screen (USB webcam, document camera, etc.)
38 |
Correct USB cable for the device
39 |
Remote debugging enabled for phone demos
40 |
41 |
42 |
What knowledge and background will the presenter most likely need?
43 |
44 |
45 |
46 |
What should the audience have?
47 |
48 |
49 |
What hardware and software will the audience need?
50 |
What knowledge and background is the audience recommended to have? For beginner level kits, please include even basics like understanding how to write a simple web page or understanding how to use an editor.
51 |
52 |
53 |
54 |
Learning objectives
55 |
56 |
After you present or teach this content kit, your audience will know how to:
57 |
58 |
59 |
60 |
61 |
62 |
63 |
Link to materials
64 |
65 |
Project resources overview
66 |
67 |
68 |
Source code: link
69 |
Live demo: link
70 |
Issue tracker/feedback: link
71 |
Builds: link
72 |
73 |
74 |
Supporting docs/references
75 |
76 |
77 |
Docs: link
78 |
Wiki: link
79 |
tutorial: link
80 |
81 |
82 |
83 |
Presentation setup
84 |
85 |
86 |
Link to slides
87 |
Links to videos of the presentation materials being used (optional)
88 |
89 |
90 |
Include notes here on presenting or using the materials
91 |
92 |
Demo setup
93 |
94 |
95 |
Link to demos
96 |
Demo script:
97 |
98 |
A walkthrough of how to run the demo
99 |
Main points to make
100 |
101 |
102 |
Troubleshooting:
103 |
104 |
Things that might be broken
105 |
Things that might be broken
106 |
107 |
108 |
Links to videos of the demos being used
109 |
Instructions for how to give the demo offline
110 |
111 |
112 |
Active learning
113 |
114 |
If possible, include some kind of active learning mechanism in your content kit slides, to break up the presentation a bit. This may include links to demos that the audience can play with, live coding sections, demos that include participation from the audience, etc.
115 |
116 |
Frequently asked questions (FAQs)
117 |
118 |
119 | List any questions that the presenter might get here, especially any "difficult" questions. Or link to a file of FAQs.
120 |
121 |
122 |
123 |
Question 1
124 |
Question 1 answer
125 |
Question 2
126 |
Question 2 answer
127 |
etc.
128 |
etc.
129 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | CC0 1.0 Universal
2 |
3 | Statement of Purpose
4 |
5 | The laws of most jurisdictions throughout the world automatically confer
6 | exclusive Copyright and Related Rights (defined below) upon the creator and
7 | subsequent owner(s) (each and all, an "owner") of an original work of
8 | authorship and/or a database (each, a "Work").
9 |
10 | Certain owners wish to permanently relinquish those rights to a Work for the
11 | purpose of contributing to a commons of creative, cultural and scientific
12 | works ("Commons") that the public can reliably and without fear of later
13 | claims of infringement build upon, modify, incorporate in other works, reuse
14 | and redistribute as freely as possible in any form whatsoever and for any
15 | purposes, including without limitation commercial purposes. These owners may
16 | contribute to the Commons to promote the ideal of a free culture and the
17 | further production of creative, cultural and scientific works, or to gain
18 | reputation or greater distribution for their Work in part through the use and
19 | efforts of others.
20 |
21 | For these and/or other purposes and motivations, and without any expectation
22 | of additional consideration or compensation, the person associating CC0 with a
23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
25 | and publicly distribute the Work under its terms, with knowledge of his or her
26 | Copyright and Related Rights in the Work and the meaning and intended legal
27 | effect of CC0 on those rights.
28 |
29 | 1. Copyright and Related Rights. A Work made available under CC0 may be
30 | protected by copyright and related or neighboring rights ("Copyright and
31 | Related Rights"). Copyright and Related Rights include, but are not limited
32 | to, the following:
33 |
34 | i. the right to reproduce, adapt, distribute, perform, display, communicate,
35 | and translate a Work;
36 |
37 | ii. moral rights retained by the original author(s) and/or performer(s);
38 |
39 | iii. publicity and privacy rights pertaining to a person's image or likeness
40 | depicted in a Work;
41 |
42 | iv. rights protecting against unfair competition in regards to a Work,
43 | subject to the limitations in paragraph 4(a), below;
44 |
45 | v. rights protecting the extraction, dissemination, use and reuse of data in
46 | a Work;
47 |
48 | vi. database rights (such as those arising under Directive 96/9/EC of the
49 | European Parliament and of the Council of 11 March 1996 on the legal
50 | protection of databases, and under any national implementation thereof,
51 | including any amended or successor version of such directive); and
52 |
53 | vii. other similar, equivalent or corresponding rights throughout the world
54 | based on applicable law or treaty, and any national implementations thereof.
55 |
56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of,
57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
59 | and Related Rights and associated claims and causes of action, whether now
60 | known or unknown (including existing as well as future claims and causes of
61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum
62 | duration provided by applicable law or treaty (including future time
63 | extensions), (iii) in any current or future medium and for any number of
64 | copies, and (iv) for any purpose whatsoever, including without limitation
65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
66 | the Waiver for the benefit of each member of the public at large and to the
67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver
68 | shall not be subject to revocation, rescission, cancellation, termination, or
69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work
70 | by the public as contemplated by Affirmer's express Statement of Purpose.
71 |
72 | 3. Public License Fallback. Should any part of the Waiver for any reason be
73 | judged legally invalid or ineffective under applicable law, then the Waiver
74 | shall be preserved to the maximum extent permitted taking into account
75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
76 | is so judged Affirmer hereby grants to each affected person a royalty-free,
77 | non transferable, non sublicensable, non exclusive, irrevocable and
78 | unconditional license to exercise Affirmer's Copyright and Related Rights in
79 | the Work (i) in all territories worldwide, (ii) for the maximum duration
80 | provided by applicable law or treaty (including future time extensions), (iii)
81 | in any current or future medium and for any number of copies, and (iv) for any
82 | purpose whatsoever, including without limitation commercial, advertising or
83 | promotional purposes (the "License"). The License shall be deemed effective as
84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the
85 | License for any reason be judged legally invalid or ineffective under
86 | applicable law, such partial invalidity or ineffectiveness shall not
87 | invalidate the remainder of the License, and in such case Affirmer hereby
88 | affirms that he or she will not (i) exercise any of his or her remaining
89 | Copyright and Related Rights in the Work or (ii) assert any associated claims
90 | and causes of action with respect to the Work, in either case contrary to
91 | Affirmer's express Statement of Purpose.
92 |
93 | 4. Limitations and Disclaimers.
94 |
95 | a. No trademark or patent rights held by Affirmer are waived, abandoned,
96 | surrendered, licensed or otherwise affected by this document.
97 |
98 | b. Affirmer offers the Work as-is and makes no representations or warranties
99 | of any kind concerning the Work, express, implied, statutory or otherwise,
100 | including without limitation warranties of title, merchantability, fitness
101 | for a particular purpose, non infringement, or the absence of latent or
102 | other defects, accuracy, or the present or absence of errors, whether or not
103 | discoverable, all to the greatest extent permissible under applicable law.
104 |
105 | c. Affirmer disclaims responsibility for clearing rights of other persons
106 | that may apply to the Work or any use thereof, including without limitation
107 | any person's Copyright and Related Rights in the Work. Further, Affirmer
108 | disclaims responsibility for obtaining any necessary consents, permissions
109 | or other rights required for any use of the Work.
110 |
111 | d. Affirmer understands and acknowledges that Creative Commons is not a
112 | party to this document and has no duty or obligation with respect to this
113 | CC0 or use of the Work.
114 |
115 | For more information, please see
116 |
117 |
--------------------------------------------------------------------------------