Devrel/Hacks

From MozillaWiki
Jump to: navigation, search

Info about the Hacks blog and how you can participate.

Mozilla Hacks is a pragmatic blog for designers, developers, deciders and people who make the web. We cover Firefox development, as well as website and web platform development from a technical perspective for people who make websites (or apps or services). Mozilla Hacks is managed by the Developer Relations team. Havi Hoffman is managing editor.

We also manage the MozHacks YouTube Channel and the @mozhacks twitter account. Please contact Istvan 'Flaki' Szmozsanszky or Havi if you need a tweet or a RT from @mozhacks.

Writers' Guidelines

Workflow and review process for Hacks posts

  • If you have a timely and pragmatic original post on a technical topic of interest (Firefox, Mozilla, JavaScript, CSS, web design and development, the web platform and advanced development, Emerging Tech projects), we'd love to hear from you. Please contact Havi Hoffman by email or via Slack with a brief description of your article.
  • Workflow: Please share your first draft in a Gdoc, and help us identify key stakeholders/approvers/review who will need to review and share feedback. Once all comments are in the Gdoc and have been resolved, the post author is responsible for adding the draft directly to wordpress. We'll establish a publication date, share with all relevant social channels, and prior to publication we do a final copyedit and link check in the wordpress post.
  • We typically publish 2-3 times weekly on Tues - Thur, 8am pt. We avoid scheduling more than one article on any given day.
  • When you write for Hacks, you are welcome to cross-post to another blog or Medium channel/account, but we ask that you DO NOT publish until we have published on Hacks.

House Style

  • We respect sentence case (EU style) and Title Case (US style) titles. British and Canadian authors are welcome to use British English spelling. (We are a global, geo-distributed organization, right?)
  • Please do not use emoji in titles, they break on some platforms. Also, please do not use H1 headers. Use H2 for section headers, H3 for sub-headers. Please do NOT include links in headers. They will be removed.

Code syntax for Hacks posts

  • We're now using the wp-highlight.js plugin for code syntax highlighting/display.
  • It autodetects a wide variety of programming languages
  • Format: <pre><code class="js">keep on rocking the free web foo</code></pre>

Images, captions, and video

  • Author bio image: You can connect a gravatar.com image with the email address listed in Wordpress to display an author photo or image alongside your bio.
  • Images in a post: Upload via "Add media" link in Wordpress. WP will host your image. Use the upload link to embed video also. Please don't host images externally.
  • IMPORTANT A11y requirement: Don't forget to include a description of the image in the alt= field provided, for screenreaders. A post is not complete until alt text is available for every image.
  • For video, here's a format that works: [embed]YOUR VIDEO EMBED URL[/embed]

Links: We like links!

  • We like them best in the body of the article, rather than served as relative links with a separate Reference or Footnotes section at the bottom
  • Please use the target="_blank" argument in your URL call. In the WP-editor you can "Open link in a new window/tab" when you use the "Insert/edit link" UI.
  • Look for places to link to relevant technical content from Mozilla Developer Network (e.g. articles about new features, functions, or APIs) or Wikipedia (esp for technical acronyms). Don't assume your readers know where to look.
  • Length: Most Hacks articles fall in the range of 800-1500 words. Some run longer, but if they run much longer we'll encourage you to write a series rather than a single post.

Markdown

  • We have a plugin that automagically converts Markdown to HTML. You should be able to write in MD and save draft.

Editorial Calendar

We maintain a Hacks Editorial calendar on Mozilla's gcal - if you are Mozilla staff you can access it here: Mozilla Hacks Editorial calendar If you are an NDA'ed Mozillian who needs access, you may request it by pinging Havi. We're working on an Airtable view. Please ping if you have a Mozilla Airtable account and this is of interest.