Submitting a Tutorial

So you want to write a Dojo tutorial? Great! Just a few things to get started.

Step 1: Determine what to write

There are many people writing tutorials. Before you start writing check the tutorial list to find out what topics are already being covered. If the topic you want to write about isn't already in progress (or even listed) drop us a note and let us know what you're planning to write about. We'll update our list, create a ticket and assign it to you.

Step 2: Download the tutorial template

You don't have to start from scratch. We've created an easy to use template. Inside the zip file you'll find a few files and folders.

• index.html - This is where you'll write your tutorial. It includes all the syntax highlighting and CSS that you're likely to need.
• /demo/demo.html - This is a barebones template to use for your tutorial's demos.
• /demo/style.css - A stylesheet to be used for your demos.
• /images - Any images required for your tutorial or demos. This folder also contains a placeholder for the author's image (avatar.jpg).
• /resources - This folder is for any resources your demos might need such as json files.

The tutorial template includes code examples which use SyntaxHighlighter. Everything you need to highlight JavaScript, CSS and HTML are included by default.

Step 3: Write your tutorial

Now that you have the template unzipped you just need to start writing. The README.txt in the root of the zip file contain some tips on laying out a strong tutorial. The most important thing to remember is that a tutorial isn't just showing the user some blocks of code but explaining how those blocks of code work and why. Give them practical examples of where and when to use the techniques you're teaching.

Demos

Code samples are great but we want to show them that the code example actually works, so that's where the view demo button comes in. Note that it's ok to have a few code samples strung together that lead up to a single demo. Your demos should also use the same code as shown in the code samples.

Testing

You should test your demos in all Dojo supported browsers for the release you're coding against. For instance, Dojo 1.6 supports IE 6, 7 and 8, Firefox 3.6, Opera 10, Chrome 8.

Step 4: Submit your tutorial

Now that your tutorial is complete it's time to send it our way so we can review and post it! Simply go to the ticket we created for you and tell us where to download the tutorial from (a zip file or GitHub URL for example). We'll review it and let you know if any changes are needed. If everything is good we'll let you know when it'll be posted. This is also a good time to give us a short author bio (under 3 lines) and a picture of yourself. Please note that while your family pet may be cute we require a picture of you, the author.

License

Please note that all tutorials sent to us to be published on the website will be posted under the same license as the Dojo Toolkit.