Devrel/Hacks: Difference between revisions

(Mozilla Hacks is a pragmatic blog for designers, developers, and people who make the web. We cover Firefox development, and the varied engineering work that tests, releases, supports and secures the browser. Melissa Thermidor is Managing Dditor.)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Info about the Hacks blog and how you can participate.  
[https://hacks.mozilla.org Mozilla Hacks] is a pragmatic blog for designers, developers, deciders and people who make the web. We cover Firefox development, and the varied engineering work that tests, releases, supports and secures the browser. Hacks also publish pragmatic explanations of emerging standards and new APIs, reports on tooling for website and web platform development, as well as news from the MDN Web Docs team, where we document the web, and past events and activities of the Developer Relations team.  


[https://hacks.mozilla.org Mozilla Hacks] is a pragmatic blog for people who make the Web. We cover Firefox development and web platform development from a technical perspective for people who make websites (or web apps or web services). Mozilla Hacks is managed by the Developer Relations team. [https://mozillians.org/en-US/u/havi/ Havi Hoffman] is managing editor.  
Mozilla Hacks is managed by the Community team and [https://people.mozilla.org/p/melissathermidor Melissa Thermidor] is Managing Editor.  


We also manage the [https://www.youtube.com/user/mozhacks MozHacks YouTube Channel] and the [https://twitter.com/mozhacks @mozhacks twitter account]. Please contact [https://mozillians.org/en-US/u/Flaki/ Istvan 'Flaki' Szmozsanszky] or Havi if you need a tweet or a RT from @mozhacks.  
We also manage the [https://www.youtube.com/user/mozhacks Mozilla HacksYouTube Channel] as well as the [https://twitter.com/mozhacks Mozilla Developer] and [https://twitter.com/mozdevnet MDN Web Docs] Twitter accounts. Please contact Melissa Thermidor if you need content shared from these social media accounts.
 
Everyone has a voice and we would like you to use our platform to connect with developers. We are seeking technical content, opinions, and stories from many different viewpoints.
 
If your work touches the work of developers, but you're not sure what to write about, let's chat directly about telling your story. Happy to meet in our new reality of Zoom ‘real-time’ or address questions async on Slack, or email. Sometimes a conversation can clarify a storyline, or shed light on how to most effectively share your new learning or key idea.
 
Engineers have asked, "I'm a software developer. I'm not a writer. Can you help?"
 
Yes, we can. We are happy to meet people where they are, and work 1:1 with you, your topic, and your idea.


==Writers' Guidelines==
==Writers' Guidelines==
==== Workflow and review process for Hacks posts ====
==== Workflow and review process for Hacks posts ====
*If you have a timely and pragmatic original post on a 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 by email or Slack.  
*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), we'd love to hear from you. Please complete a [https://docs.google.com/document/d/1IowAUtyex_nwBdnMVN983uzZVFAZ7NdPTiJvUMYw3s4/edit?usp=sharing request form] and send it to Melissa Thermidor by email 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 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.  
Please share your first draft in a Google Doc, 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. Don't worry about copyediting, SEO, etc - the managing editor will make these changes. 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 typically publish 1-2 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 also release on Hacks.
* 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 ====
==== 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?)  
*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 H1 headers. Use H2 for section headers, H3 for sub-headers. Please do NOT include links in headers. They will be removed.
*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 ====
==== Code syntax for Hacks posts ====
Line 26: Line 34:


==== Images, captions, and video ====  
==== 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.
*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.  
*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'''.  
*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'''.  
Line 43: Line 51:


== Editorial Calendar ==
== Editorial Calendar ==
We maintain a Hacks Editorial calendar on Mozilla's gcal - if you are Mozilla staff you can access it here: [https://calendar.google.com/calendar/embed?src=mozilla.com_h1vjme6vi1m7o3f05vv32qa2a4@group.calendar.google.com&ctz=America/Los_Angeles Mozilla Hacks Editorial calendar] If you are an NDA'ed Mozillian who needs access, you may request it by pinging Havi.
We maintain a Hacks Editorial calendar on Mozilla's GCal - if you are Mozilla staff you can access it here: [https://calendar.google.com/calendar/embed?src=mozilla.com_h1vjme6vi1m7o3f05vv32qa2a4@group.calendar.google.com&ctz=America/Los_Angeles Mozilla Hacks Editorial calendar] If you are an NDA'ed Mozillian who needs access, you may request it by sending a message to Melissa Thermidor.
 
==Completed Posts==
{| class="fullwidth-table"
|- style="background:#efefef"
| '''Article Idea'''
| '''Status'''
| '''Product Areas'''
| '''Links'''
| '''Notes'''
|-
 
| FxOS App Startup Performance || {{done|}} || Firefox OS, mobile web ||  || Dietrich reached out to Eli Perlman, who's writing tools and best practices for this. He agreed and gave an ETA of sometime Q1. Q2 post on Raptor!
|-
| Battery API new spec || {{done|}} || Web / HTML || {{bug|1050749 }} || Article about the new spec in coordination w/ Firefox implementation by franciov (Francesco Iovine)
|-
| Payments API || {{done|}} || Firefox OS, Firefox (now)|| {{bug|1133963}}, {{bug|1134481}}, {{bug|1034326}} || Kumar did an intro, but we need to push on it's story. How have people actually used it? Testimonial stories from devs who've implemented would be dope. (Havi: UPDATE: Fxpay updates from Kumar - published April 21) https://hacks.mozilla.org/2015/04/easier-in-app-payments-with-fxpay/
|-
| Power-positive Patterns || {{done|}} || Firefox OS ||  || Portland State University student project exploring JavaScript APIs for accessing the network in a condition-aware and battery-aware way. Dietrich mentoring. ETA mid-March. Published April 20. https://hacks.mozilla.org/2015/04/network-activity-and-battery-drain-in-mobile-web-apps/
|-
| WebRTC in Firefox 38: Multistream and renegotiation || {{done|}} || WebRTC ||  || Maire Reavy & team (Nils Ohlmeier, Byron Campen) Published March 25.
|-
| Fetch API Introduction || {{done|}} || Firefox, Firefox OS, Android || {{bug|1039846}} || Nikhil Marathe agreed to write. Scheduled for 3/10
|-
| CSS Counter Style Level 3 || {{done|}} || CSS || http://dev.w3.org/csswg/css-counter-styles-3/ || MDN contributor Saurabh Nair aka jsx, scheduled 2/11
|-
| FxOS Web Server || {{done|}} || Firefox OS || https://github.com/justindarc/fxos-web-server || Justin Darcangelo IRC: justindarc (Havi in touch, scheduled 2/9)
|-
| Canvas updates || {{done|}} || Canvas API ||  || Florian Scholz from MDN (Havi will contact)
|-
| Broadcast Channel API || {{done|}} || Firefox OS || {{bug|966439}} || Havi: Jweathersby has a draft - week of 2/2
|-
| Project Silk || {{done|}} || Firefox OS (and more?) ||  || Mason Chang blogged, and reposting to Hacks!
|-
| Functional JavaScript || {{done|}}  || JavaScript; programming language ||  || This is an article post on MozTPE's blog, which introduces the language feature in functional programming flavor, and shows how much nice tricks JavaScript could play with. I've modified and translated it in English, with lots of additional information & links. (Greg Weng) This note left by Greg, Dietrich introduced to Havi to get this rolling.
|-
| Node Firefox OS  || {{done|}} || Firefox OS ||  || Sole: published 2/5
|}

Latest revision as of 13:18, 2 December 2020

Mozilla Hacks is a pragmatic blog for designers, developers, deciders and people who make the web. We cover Firefox development, and the varied engineering work that tests, releases, supports and secures the browser. Hacks also publish pragmatic explanations of emerging standards and new APIs, reports on tooling for website and web platform development, as well as news from the MDN Web Docs team, where we document the web, and past events and activities of the Developer Relations team.

Mozilla Hacks is managed by the Community team and Melissa Thermidor is Managing Editor.

We also manage the Mozilla HacksYouTube Channel as well as the Mozilla Developer and MDN Web Docs Twitter accounts. Please contact Melissa Thermidor if you need content shared from these social media accounts.

Everyone has a voice and we would like you to use our platform to connect with developers. We are seeking technical content, opinions, and stories from many different viewpoints.

If your work touches the work of developers, but you're not sure what to write about, let's chat directly about telling your story. Happy to meet in our new reality of Zoom ‘real-time’ or address questions async on Slack, or email. Sometimes a conversation can clarify a storyline, or shed light on how to most effectively share your new learning or key idea.

Engineers have asked, "I'm a software developer. I'm not a writer. Can you help?"

Yes, we can. We are happy to meet people where they are, and work 1:1 with you, your topic, and your idea.

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), we'd love to hear from you. Please complete a request form and send it to Melissa Thermidor by email with a brief description of your article.

Please share your first draft in a Google Doc, 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. Don't worry about copyediting, SEO, etc - the managing editor will make these changes. 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 1-2 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 sending a message to Melissa Thermidor.