Devrel/Hacks: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(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.)
 
(73 intermediate revisions by 6 users not shown)
Line 1: Line 1:
The future home of 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://wiki.mozilla.org/HacksPostMigrationUserDetails Hacks Migration info for authors]  
Mozilla Hacks is managed by the Community team and [https://people.mozilla.org/p/melissathermidor Melissa Thermidor] is Managing Editor.
* Ideas (Please add yours here)


{| class="fullwidth-table"
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.  
|- style="background:#efefef"
 
| '''Article Idea'''
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.
| '''Status'''
 
| '''Product Areas'''
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.  
| '''Links'''
 
| '''Notes'''
Engineers have asked, "I'm a software developer. I'm not a writer. Can you help?"
|-
 
| RequestSync API || {{ok|}} || Firefox OS || {{bug|1018320}} || No MDN docs yet, shipping in FxOS 2.2 likely. Baku was fine with re-publishing [http://143th.net/post/108551021821/requestsync-api his post] on Hacks. Dietrich connected Baku (Andrea M) to Havi. Post on hold until the API is shipping.
Yes, we can. We are happy to meet people where they are, and work 1:1 with you, your topic, and your idea.
|-
 
| Web Bluetooth API v2 || {{ok|}} || Firefox OS / IoT || {{bug|1005848}}, [https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2 wiki] || Notable change is Bluetooth LE. Dietrich contacted Ben Tian about it, most of the APIs are privileged (yay!) but not shipping until FxOS v3 (boo).
==Writers' Guidelines==
|-
==== Workflow and review process for Hacks posts ====
| Bluetooth Data Channels || {{ok|}} || Firefox OS / IoT ||  || Article on BT-as-transport-layer for mesh and disconnected msging. Who to contact?
*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.
|-
 
| Gallery Scrollview Architecture || {{ok|}} || Firefox OS ||  || Dietrich will ask DJF and Andew Sliwinski. Something iOS/Android do well, but SUPER hard to do well on Web. See Roc's 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.  
|-
 
| Project Silk || {{done|}} || Firefox OS (and more?) ||  || Mason Chang blogged, and reposting to Hacks!
*We typically publish 1-2 times weekly on Tues - Thur, 8am PT. We avoid scheduling more than one article on any given day.
|-
 
| Inter App Communication API || {{ok|}} || Firefox OS || {{bug|876397}} || Used for media-on-lockscreen in Gaia, maybe certified only. Need to figure out priv'd uplift plan. Dietrich will ask Gaia team.
* 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.
|-
 
| Broadcast Channel API || {{ok|}} || Firefox OS || {{bug|966439}} || Havi: Jweathersby has a draft - week of 2/2
==== 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?)
| JPM || {{ok|}} || Firefox, Android ||  ||New Jetpack + Node.js tool to replace CFX. Dietrich will ask Erik Vold.
 
|-
*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.  
| Node Firefox OS  || {{ok|}} || Firefox OS ||  || Sole shepherding it now?
 
|-
==== Code syntax for Hacks posts ====
| System Message API || {{ok|}} || Firefox OS || [https://developer.mozilla.org/en-US/docs/Web/API/Navigator.mozSetMessageHandler MDN docs] || Not sure what the right content or person is.
*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
| FxOS Media Remote Controls || {{ok|}} || Firefox OS || [http://mxr.mozilla.org/gaia/source/shared/js/media/remote_controls.js src] || Dietrich will ask Jim Porter?
*Format: <pre><code class="js">keep on rocking the free web foo</code></pre>
|-
 
| Presentation API || {{ok|}} || Firefox OS, IoT || {{bug|1080474}} || Device discovery and display! Dietrich asked Gina Yeh and Shih-Chiang Chien, but they say it's not ready to write about yet.
==== 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.
| Gaia Web Component Migration || {{ok|}} || Firefox OS ||  || Gaia team members migrating from Building Blocks to web components. Wins, hurdles, lessons learned. Large project web component patterns. Dietrich will ask Gaia team.
*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'''.  
| Payments API || {{ok|}} || Firefox OS, Firefox (soon) ||  || 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: Actually, there's a series of [https://hacks.mozilla.org/?s=payments payments posts], but not a lot of testimony that we'd want to share widely yet. Next Marketplace news re: payments will be early Feb. Stay tuned)
 
|-
* For video, here's a format that works: [embed]YOUR VIDEO EMBED URL[/embed]
| Fetch API || {{ok|}} || Firefox, Firefox OS, Android || {{bug|1039846}} || Yes please. Dietrich will poke Nikhil Marathe and Ben Kelly.
 
|-
==== Links: We like links! ====
| Power-positive Patterns || {{ok|}} || Firefox OS ||  || Dietrich's student project for making it super easy for web developers to access the network in a power-and-network-consumption aware way. Dietrich will write.
*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.  
| Functional JavaScript || {{ok|}} || 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)
*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. 
|-
 
| Canvas updates || {{done|}} || Canvas API ||  || Florian Scholz from MDN (Havi will contact)
*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.  
|-
 
| Firefox Hello || {{ok|}} || WebRTC ||  || Maire Reavy & team (Havi is in touch w/Maire) Mid-Feb.
==== Markdown ====
|-
*We have a plugin that automagically converts Markdown to HTML. You should be able to write in MD and save draft.
| Shumway || {{ok|}} || Moz Research ||  || Michael Bebenita, Chris Peterson & team (Havi is in touch-February)
 
|-
== Editorial Calendar ==
| Web Animations API || {{ok|}} || Firefox, Firefox OS, Android || [https://github.com/web-animations/web-animations-js polyfill] || Dietrich will contact Rachel Nabors.
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.
|-
| RTL in Web Apps || {{ok|}} || Firefox, Firefox OS, Android ||  || Dietrich will reach out to Gaia team implementing RTL in 2.2
|-
| Mulet || {{ok|}} || Firefox OS, DevTools ||  || Desktop dev environment for developing Gaia. Dietrich will reach out to Ochameau.
|}

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.

Retrieved from "https://wiki.allizom.org/index.php?title=Devrel/Hacks&oldid=1232471"