Confirmed users
1,021
edits
Devrel/Hacks: Difference between revisions
Jump to navigation
Jump to search
→Writers' Guidelines: updates
No edit summary |
(→Writers' Guidelines: updates) |
||
| Line 5: | Line 5: | ||
==Writers' Guidelines== | ==Writers' Guidelines== | ||
==== Workflow and review process for Hacks posts ==== | |||
*If you have a timely and pragmatic technical topic of interest (Firefox, Mozilla, the web platform, JavaScript) to Hacks' primary audience of web developers, designers, and people who make the web, we'd love to hear from you. Please contact Havi Hoffman and/or Jason Weathersby by email, IRC, Slack. | |||
*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 will add the draft directly to wordpress. We'll establish a publication date, share with all relevant social channels, and prior to publication we'll do a final copyedit and link check in the wordpress post. | |||
We typically publish | *We typically publish 2-3 times weekly on Tues - Thur, 8am pt. | ||
==== House Style ==== | |||
*We respect sentence case (EU style) and Title Case (US style) titles - but we tend to like consistency in any given post. British and Canadian authors are welcome to use British English spelling. (We are a global, geo-distributed organization, right?) | |||
*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 [https://wordpress.org/plugins/wp-highlightjs/ 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> | |||
==== 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. | *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. | ||
==== Images 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. | |||
*Upload via "Add media" link in Wordpress. WP will host your image. Use the upload link to embed video also. | |||
*Markdown | *Markdown | ||
*We also have a NEW plugin that automagically converts Markdown to HTML. You should be able to write in MD and save draft. | |||
* Ideas (Please add yours below) | * Ideas (Please add yours below) | ||