braziljs mdn

Post on 15-May-2015

195 Views

Category:

Technology

2 Downloads

Preview:

Click to see full reader

DESCRIPTION

This set of slides accompanies the MDN workshop held at BrazilJS 2014. It features a guide to getting started with contributing to the Mozilla Developer Network documentation resource, and links to JavaScript and API work to get started on.

TRANSCRIPT

MDN WorkshopBrazilJS 2014

Hello!

1. Let’s say hi… 2. …learn what to do… 3.…and write some awesome docs and demos!

!

Slides at slideshare.net/chrisdavidmills/braziljs-mdn

Hello!

Today’s personnel

• Florian Scholz: JavaScript ref docs • Chris Mills: API docs • Ricardo Brandão: Translations and local support

How to contribute

You just have to log in...• This is mainly just to cut down on some spam • And to share recognition, and blame! • You can log in with Persona

Once logged in

• You can edit pages • Translate pages • Create new pages

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 #mdn) • Ask us questions!

Editing

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! • We don’t expect perfect language and styling

Edit toolbar

!

!

!

developer.mozilla.org/en-US/docs/Project:MDN/Contributing/Editor_guide

Footer controls

Create a new article

Code samples

• The best way to provide code samples is to use your favourite mechanism

• We’d recommend Github… • …but you could use JSBin, or JSFiddle, or … ;-)

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

Translations

• Don’t just start translating the English page! • Use the translation menu up the top of the article • Select Add a translation • Select language • Then use the provided interface

Translations

Translations

Translation updates

• Keeping translations updated can be a pain… • …when the original changes • Use the “subscribe” feature to

watch pages you’ve translated

Kuma development

• If you are a ninja (or at least a samurai, or pirate) • You could help develop the system • It’s on Github • github.com/mozilla/kuma • developer.mozilla.org/en-US/docs/Project:MDN/

Kuma/Contributing

What to work on

In this session

• We wanted to focus on JavaScript, Glossary & APIs • See https://etherpad.mozilla.org/braziljs-workshop-

mdn • Also see https://developer.mozilla.org/en-US/docs/

MDN/Doc_status • Want to work on something? put your name on it • If you want to work on something else, talk to us!

The aftermath

Didn’t we do well!

• Let’s look at what we did during the workshop • Ask questions • Get t-shirts • Go have fun • Come visit our booth at BrazilJS!

Thanks! cmills@mozilla.com || @chrisdavidmills

fscholz@mozilla.com || @floscholz

top related