{"id":1870,"date":"2011-07-22T14:15:12","date_gmt":"2011-07-22T22:15:12","guid":{"rendered":"http:\/\/blog.mozilla.org\/webdev\/?p=1870"},"modified":"2011-07-22T14:15:12","modified_gmt":"2011-07-22T22:15:12","slug":"lets-write-some-docs","status":"publish","type":"post","link":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/","title":{"rendered":"Let&#8217;s write some docs"},"content":{"rendered":"<p class=\"img-wrap\"><a class=\"img-wrap\" href=\"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png\"><img decoding=\"async\" loading=\"lazy\" class=\"size-full wp-image-1871 alignright\" title=\"FF_heart_RTD\" src=\"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png\" alt=\"\" width=\"410\" height=\"200\" srcset=\"https:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png 410w, https:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD-300x146.png 300w\" sizes=\"(max-width: 410px) 100vw, 410px\" \/><\/a><\/p>\n<p>We decided to sponsor <a href=\"http:\/\/rtfd.org\">Read the Docs<\/a> in a roundabout fashion.<\/p>\n<p>Documentation is important. It helps us understand what it is we\u2019re building, and since everything we do is open source it helps others understand how to use our tools or contribute to us.<\/p>\n<p>Before the Great Python Revolution at Mozilla, we were documenting things in a wiki, and relying on good habits to keep documentation up to date. Good habits are hard to maintain.<\/p>\n<p>Once we started using python extensively, writing things in <a href=\"http:\/\/sphinx.pocoo.org\">Sphinx<\/a> seemed natural. Since a lot of our projects were in GitHub, we wrote a lot of scripts to automatically build our docs and push them into Github Pages. This also suffered from hard to maintain good habits.<\/p>\n<p>We eventually stumbled upon <a href=\"http:\/\/rtfd.org\">Read The Docs<\/a>. An open source project that automatically takes your documentation and builds it and hosts it. Slowly we started pushing more and more of our projects to <a href=\"http:\/\/rtfd.org\">Read the Docs<\/a>. Suddenly writing documentation started to pay off. Our results were immediately visible, and documentation now became a priority.<\/p>\n<p>So we decided to support Read the Docs by giving them a build server. The architecture at Read the Docs makes it so that they aren\u2019t dependent on our server, but since it\u2019s there it will get use, and it will make building documentation a lot faster and easier. Our hope is that more open source projects will put time and effort into documentation, thus making them easier to use.<\/p>\n<p>So have a look at this amazing project and start writing some docs.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>We decided to sponsor Read the Docs in a roundabout fashion. Documentation is important. It helps us understand what it is we\u2019re building, and since everything we do is open source it helps others understand how to use our tools &hellip; <a class=\"go\" href=\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/\">Continue reading<\/a><\/p>\n","protected":false},"author":155,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[288],"tags":[],"coauthors":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v22.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Let&#039;s write some docs - Mozilla Web Development<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Dave Dash\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/\",\"url\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/\",\"name\":\"Let's write some docs - Mozilla Web Development\",\"isPartOf\":{\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#primaryimage\"},\"thumbnailUrl\":\"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png\",\"datePublished\":\"2011-07-22T22:15:12+00:00\",\"dateModified\":\"2011-07-22T22:15:12+00:00\",\"author\":{\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/#\/schema\/person\/99ae5aa8c944927c3d6da33b2d41c5cf\"},\"breadcrumb\":{\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#primaryimage\",\"url\":\"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png\",\"contentUrl\":\"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/blog.mozilla.org\/webdev\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Let&#8217;s write some docs\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/#website\",\"url\":\"https:\/\/blog.mozilla.org\/webdev\/\",\"name\":\"Mozilla Web Development\",\"description\":\"For make benefit of glorious tubes\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/blog.mozilla.org\/webdev\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/#\/schema\/person\/99ae5aa8c944927c3d6da33b2d41c5cf\",\"name\":\"Dave Dash\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/blog.mozilla.org\/webdev\/#\/schema\/person\/image\/c5d2a49195aa668673b79670abd1be53\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/b4ef6e384d3fb4be8b232c2655403e0e?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/b4ef6e384d3fb4be8b232c2655403e0e?s=96&d=mm&r=g\",\"caption\":\"Dave Dash\"},\"description\":\"Dave is a Senior Web Developer at Mozilla. He works on Firefox Input, Mozillians, Playdoh and Elastic Search.\",\"url\":\"https:\/\/blog.mozilla.org\/webdev\/author\/ddashmozillacom\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Let's write some docs - Mozilla Web Development","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/","twitter_misc":{"Written by":"Dave Dash","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/","url":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/","name":"Let's write some docs - Mozilla Web Development","isPartOf":{"@id":"https:\/\/blog.mozilla.org\/webdev\/#website"},"primaryImageOfPage":{"@id":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#primaryimage"},"image":{"@id":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#primaryimage"},"thumbnailUrl":"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png","datePublished":"2011-07-22T22:15:12+00:00","dateModified":"2011-07-22T22:15:12+00:00","author":{"@id":"https:\/\/blog.mozilla.org\/webdev\/#\/schema\/person\/99ae5aa8c944927c3d6da33b2d41c5cf"},"breadcrumb":{"@id":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#primaryimage","url":"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png","contentUrl":"http:\/\/blog.mozilla.org\/webdev\/files\/2011\/07\/FF_heart_RTD.png"},{"@type":"BreadcrumbList","@id":"https:\/\/blog.mozilla.org\/webdev\/2011\/07\/22\/lets-write-some-docs\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/blog.mozilla.org\/webdev\/"},{"@type":"ListItem","position":2,"name":"Let&#8217;s write some docs"}]},{"@type":"WebSite","@id":"https:\/\/blog.mozilla.org\/webdev\/#website","url":"https:\/\/blog.mozilla.org\/webdev\/","name":"Mozilla Web Development","description":"For make benefit of glorious tubes","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/blog.mozilla.org\/webdev\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/blog.mozilla.org\/webdev\/#\/schema\/person\/99ae5aa8c944927c3d6da33b2d41c5cf","name":"Dave Dash","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.mozilla.org\/webdev\/#\/schema\/person\/image\/c5d2a49195aa668673b79670abd1be53","url":"https:\/\/secure.gravatar.com\/avatar\/b4ef6e384d3fb4be8b232c2655403e0e?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/b4ef6e384d3fb4be8b232c2655403e0e?s=96&d=mm&r=g","caption":"Dave Dash"},"description":"Dave is a Senior Web Developer at Mozilla. He works on Firefox Input, Mozillians, Playdoh and Elastic Search.","url":"https:\/\/blog.mozilla.org\/webdev\/author\/ddashmozillacom\/"}]}},"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/posts\/1870"}],"collection":[{"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/users\/155"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/comments?post=1870"}],"version-history":[{"count":0,"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/posts\/1870\/revisions"}],"wp:attachment":[{"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/media?parent=1870"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/categories?post=1870"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/tags?post=1870"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/blog.mozilla.org\/webdev\/wp-json\/wp\/v2\/coauthors?post=1870"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}