MDN is easy!
-
date post
18-Oct-2014 -
Category
Technology
-
view
1.024 -
download
3
description
Transcript of MDN is easy!
![Page 1: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/1.jpg)
MDN is easy!A guide to contributing to the Mozilla Developer Network!
Chris Mills, Senior Tech Writer, MDN
Monday, 14 October 13
![Page 2: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/2.jpg)
By the end, you will have
1. An MDN account2. An edit to an MDN page in your name.
MDN icebreaker!
Monday, 14 October 13
![Page 3: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/3.jpg)
Why would anyone contribute to MDN?
Monday, 14 October 13
![Page 4: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/4.jpg)
For everyone!
• Yourself• Your project•Mozillians• The whole world
Monday, 14 October 13
![Page 5: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/5.jpg)
You can
• Shine• Get sex, drugs and rock ‘n’ roll• Get stickers, t-shirts and recognition• Help the community get the docs they need
Monday, 14 October 13
![Page 6: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/6.jpg)
Your project can
• Get internal and external visibility• Get promotion (in combination with Hacks blog,
evangelist talks, etc.)• Get more users and contributors
Monday, 14 October 13
![Page 7: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/7.jpg)
Mozillians, the whole world
• Gets awesome docs to help them do their work• Is able to contribute back•Will get to know you and love you
Monday, 14 October 13
![Page 8: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/8.jpg)
It’s a great platform
• Kuma — based on Django and Node.js• It’s a Wiki, on steroids• Our development team are *actually*
ninjas.
Monday, 14 October 13
![Page 9: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/9.jpg)
How to contribute?
What do you want to get out of this session?
Monday, 14 October 13
![Page 10: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/10.jpg)
You just have to log in...• This is mainly just to cut down on some spam• And to share recognition, and blame!•We use Persona
Monday, 14 October 13
![Page 11: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/11.jpg)
Once logged in
• You can edit pages• Create new pages
Monday, 14 October 13
![Page 12: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/12.jpg)
You should also
• Report bugs at bugzilla.mozilla.org (project: Mozilla Developer Network :: General)• Get help on lists.mozilla.org/listinfo/dev-mdc• Get help on IRC (wiki.mozilla.org/IRC, room #devmo)
Monday, 14 October 13
![Page 13: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/13.jpg)
Editing
Monday, 14 October 13
![Page 14: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/14.jpg)
Don’t be afraid
• Hit that edit button• And kick some ass• At the very worst, we can revert changes• But we’d rather you edit stuff than send us bugs!
Monday, 14 October 13
![Page 15: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/15.jpg)
Edit toolbar
developer.mozilla.org/en-US/docs/Project:MDN/Contributing/Editor_guide
Monday, 14 October 13
![Page 16: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/16.jpg)
Edit bar
Monday, 14 October 13
![Page 17: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/17.jpg)
Footer controls
Monday, 14 October 13
![Page 18: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/18.jpg)
Macros
•Written in KumaScript, which is pretty much just JS• https://developer.mozilla.org/en-US/docs/
Project:MDN/Contributing/Custom_macros • For example, {{HTMLElement("div")}} is found at
developer.mozilla.org/en-US/docs/Template:HTMLElement
Monday, 14 October 13
![Page 19: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/19.jpg)
How to contribute
Monday, 14 October 13
![Page 20: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/20.jpg)
Big or small
• It’s all really useful!• Some MDN contributors literally just make a handful
of small fixes each day, or week• But it improves the site quality enormously
Monday, 14 October 13
![Page 21: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/21.jpg)
Small contributions
• Typos• Correction of technical errors• Title fixes• Adding tags• Code consistency fixes• Code snippets
Monday, 14 October 13
![Page 22: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/22.jpg)
Small contributions
• Improving descriptions and examples• Proof reading, tech review•Macro fixes• Other minutiae• Feedback!
Monday, 14 October 13
![Page 23: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/23.jpg)
Large contributions
•Writing new articles• Tech editing/copy editing• Translations•Writing demos• Kuma development•Writing tools
Monday, 14 October 13
![Page 24: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/24.jpg)
Create a new article
Monday, 14 October 13
![Page 25: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/25.jpg)
Write it...
• Then request an edit
• You can also ask on the mailing list or in IRC
Monday, 14 October 13
![Page 26: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/26.jpg)
Shout about it!
• Spread the word on Twitter, Google+, etc.• Get developers interested in using the feature/tool/
whatever it is, and contributing to the docs
Monday, 14 October 13
![Page 27: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/27.jpg)
Tech/copy editing
• Can be a big task, depending on the quality or length of writing•Make most fixes yourself• For uncertainties, contact the main contributor• Ask on IRC/mail• File a bug
Monday, 14 October 13
![Page 28: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/28.jpg)
Translations
• Really useful contribution• Keep MDN internationalized!
Monday, 14 October 13
![Page 29: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/29.jpg)
Find a page to translate
Monday, 14 October 13
![Page 30: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/30.jpg)
Choose a language
Monday, 14 October 13
![Page 31: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/31.jpg)
Enter your translation
Monday, 14 October 13
![Page 32: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/32.jpg)
Collaborate!
• Start a localization group• Or join an existing one• developer.mozilla.org/en-US/docs/Project:MDN/
Localizing/Localization_projects
Monday, 14 October 13
![Page 33: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/33.jpg)
Write demos
• Some people don’t like writing prose• But excel at writing code• Good demos are a major plus
Monday, 14 October 13
![Page 34: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/34.jpg)
How to add demos
• Put them on Github• Directly, or via JSBin, Codepen.io, etc.• Link to them!
Monday, 14 October 13
![Page 35: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/35.jpg)
Live samples
• Smaller samples can be put directly on the Wiki page• Then assembled into a running demo• developer.mozilla.org/en-US/docs/Project:MDN/
Contributing/Editor_guide/#Using_the_live_sample_system
Monday, 14 October 13
![Page 36: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/36.jpg)
Write tools
•Why not write a demo that does something useful?• For example, the box-shadow generator• developer.mozilla.org/en-US/docs/Web/CSS/Tools/
Box-shadow_generator
Monday, 14 October 13
![Page 37: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/37.jpg)
Write macros
• A macro is basically just a special kind of page• developer.mozilla.org/en-US/docs/
Template:HTMLElement• In this page you enter KumaScript, which is basically
JS with some extra APIs
Monday, 14 October 13
![Page 38: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/38.jpg)
Write macros
• This JS is executed server-side• So you can’t do client-side type stuff with it• But you can automate a lot of work!• https://developer.mozilla.org/en-US/docs/
Project:MDN/Contributing/Custom_macros
Monday, 14 October 13
![Page 39: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/39.jpg)
Kuma development
• If you are a ninja (or at least a samurai, or pirate)• You might want to help develop the system• It’s on github• github.com/mozilla/kuma • developer.mozilla.org/en-US/docs/Project:MDN/
Kuma/Contributing
Monday, 14 October 13
![Page 40: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/40.jpg)
It’s a big community out there
Monday, 14 October 13
![Page 41: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/41.jpg)
CommUNITY
• Don’t feel you have to do it alone• Find others who share your immediate interests• And collaborate• Ask for help on IRC, mail
Monday, 14 October 13
![Page 42: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/42.jpg)
Repurposing content
Monday, 14 October 13
![Page 43: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/43.jpg)
Reuse!
•Why not repurpose that blog post?• Article?• Code example?• Quick-fire tip?• Or Hacks post?
Monday, 14 October 13
![Page 44: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/44.jpg)
Thanks for [email protected] || @chrisdavidmills
Chris Mills, Senior Tech Writer, MDN
Monday, 14 October 13
![Page 45: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/45.jpg)
Notes for session presenters
When running a workshop on MDN editing:
• Start with a presentation, including what you need to know to become an MDN contributor (slides 9-35?)•Make sure everyone can sign in, and find a page for
them to edit.
Monday, 14 October 13
![Page 46: MDN is easy!](https://reader034.fdocuments.us/reader034/viewer/2022051108/5443129cafaf9fe7098b47f6/html5/thumbnails/46.jpg)
Notes for session presenters
When running a workshop on MDN editing:
• Bookmark several pages containing simple-to-fix problems.• Let people choose one of these to fix (unless they
want to find something of their own).
Monday, 14 October 13