Using the CMS
Our content management system is designed to be a simple place to create your tutorial. If you've never logged in before, drop your editor an email and they'll get you set up. This guide should walk you through everything you need to know:
- Select Tutorial or Article from the New drop down menu. (Or, if you'd prefer to use Markdown, you can do that too!)
- Enter a title for your tutorial.
- Add a teaser for the tutorial. This does not appear in your tutorial itself, but should be 300-400 characters in length, clear, and written to give a reader the information they need to want to click through and do the tutorial. It should describe the tutorial, and it's visible on the tutorials homepage, as well as the topic page.
- Write your tutorial. Start with the introduction and add the whole tutorial. Here's everything you need to know about formatting but for quick reference (going from left to right in the toolbar):
- Normal is for all normal tutorial text.
- H2 is for main headings.
- H3 is for subheadings.
- H4 is for sub-subheadings.
- Question Mark button is for adding an interview question heading.
- Quote button is for adding a blockquote.
- The Bold and Italic buttons do exactly what you think they do.
- The Superscript button will convert the selected text to superscript.
- The Code button formats the selected text as inline code (for code blocks see below).
- The List buttons allow you to create numbered or bulleted lists.
- The Toggle HTML button allows you to switch from the visual editor to the HTML view. This isn't recommended. The visual editor works as a preview of what the post will look like when it's live.
- The Keyboard button shows you the keyboard shortcuts available when using the editor.
- The Link button allows you make the selected text a link.
- The Insert Image button allows you to upload and insert an image. It's worth reviewing our image guidelines.
- The Caption button allows you to add a caption to an image (the cursor must be in the image block for this to work).
- The Audio button allows you to upload and embed an audio file.
- The Video button allows you to embed a video hosted on YouTube or Vimeo (your editor will need to upload these for you first).
- The Insert Code button allows you to insert a whole block of code, using the correct syntax highlighting.
- The Table button allows you to insert a table, choosing the number of rows and columns that you'd like.
- The iFrame button allows you to insert an iFrame (you'll be asked to enter the URL to display). This is an advanced feature.
There are three images you may need to add that support the tutorial itself:
- Preview Image (required): The small image that we use throughout the site when featuring your tutorial. Here's our guidance on how to create your preview image.
- Final Product: This should be an image (or a video/audio file) that represents the end result of the tutorial.
- Check that you are selected as the Author.
- Choose the correct Topic for your tutorial.
- Choose the appropriate Difficulty.
- If your tutorial has a demo, add the url in the Demo URL box (often this will be a link to the demo on GitHub, which you can find out more about).
This section makes it easier for readers to find your tutorial, and helps them to understand what they'll need to follow along. You should choose up to five different categories for your tutorial. The first category should be the primary one that best relates to your tutorial.
Examples could be:
- For a dev tutorial: WordPress, Sass, Chrome Dev-Tools
- For a design tutorial: Photoshop, Filter Forge
- For a craft tutorial: Knitting, Knitting Needles, Yarn, Felt, Scissors
As you start typing, the CMS will automatically suggest categories that we've used in the past. Always try to choose one of these, rather than creating a new one!
You can choose from a few options for the length of your tutorial. Here are the guidelines we suggest that you follow:
- Quick: Under an hour
- Short: 1-3 hours
- Medium: 4-6 hours
- Long: 6+ hours
If you've been asked to provide an accompanying file for your tutorial (e.g. a downloadable vector, code source files, or a craft pattern PDF), there are a few things to consider. Please read our source files guide and keep the following in mind:
- Don't include any third party content (things you haven't made yourself)
- Make sure layers are named appropriately (and in the same way they are in the tutorial)
- Remove any unnecessary assets such as Symbols, Brushes, Swatches, Graphic Styles
- Keep things well organised (here's a tutorial with some useful advice)
- Our resource pack might contain useful items to base your attachment upon, such as craft pattern templates.
You can attach this file by using the Attachment box on the right. Click Choose File to upload your content.
You're now finished adding your content! Give your tutorial a thorough check, paying particular attention to formatting issues. Once you're completely finished, click Ready For Review, and then notify your editor by moving the tutorial card in Trello. Your editor will now go in to edit and schedule your tutorial.