{"id":263,"date":"2013-12-04T13:16:19","date_gmt":"2013-12-04T18:16:19","guid":{"rendered":"http:\/\/minireference.com\/blog\/?p=263"},"modified":"2021-04-02T14:18:16","modified_gmt":"2021-04-02T18:18:16","slug":"open-book-writing-and-typo-workflow","status":"publish","type":"post","link":"https:\/\/minireference.com\/blog\/open-book-writing-and-typo-workflow\/","title":{"rendered":"Open book writing and typo workflow"},"content":{"rendered":"<p>Open is better than closed because when you work in the open the whole world can help you (or at least the portion of the world that cares about what you are doing). For books in particular, readers can be tremendously helpful by <strong>submitting typo fixes<\/strong> to the book. But how can users submit typos? Surely there is something better than email&#8230;<\/p>\n<p>Today I saw a very interesting workflow for reader contributions on the\u00a0<a href=\"http:\/\/adv-r.had.co.nz\/\">Advanced R programming<\/a>\u00a0book website by Hadley Wickham. The book \u00a0is being developed on <a href=\"https:\/\/github.com\/hadley\/adv-r\">github<\/a> using the Jekyll static site generator. Each page has an &#8220;Edit this&#8221; link on the right side:<\/p>\n<p>&nbsp;<\/p>\n<p style=\"text-align: center;\"><a href=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/edit-this-page.png\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-267\" title=\"edit-this-page\" src=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/edit-this-page.png\" alt=\"\" width=\"461\" height=\"114\" \/><\/a><\/p>\n<p>The url for that button is:<\/p>\n<p><code>https:\/\/github.com\/hadley\/adv-r\/<span style=\"color: #0000ff;\"><strong>edit\/<\/strong><\/span>master\/index.rmd<\/code><\/p>\n<p>Clicking on that takes you to github and a special prompt to create a fork:<\/p>\n<p style=\"text-align: center;\"><a href=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/takes-u-to-github.png\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-266\" title=\"takes-u-to-github\" src=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/takes-u-to-github.png\" alt=\"\" width=\"426\" height=\"185\" \/><\/a><\/p>\n<p>Next you can make the change:<\/p>\n<p style=\"text-align: center;\"><a href=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/through-the-web-text-editor.png\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-265\" title=\"through-the-web-text-editor\" src=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/through-the-web-text-editor.png\" alt=\"\" width=\"494\" height=\"154\" \/><\/a><\/p>\n<p>&nbsp;<\/p>\n<p>And finally the UI offers you to do a pull request:<\/p>\n<p style=\"text-align: center;\"><a href=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/pull-request-ready-in-a-branch-called-patch-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-264\" title=\"pull-request-ready-in-a-branch-called-patch-1\" src=\"http:\/\/minireference.com\/blog\/wp-content\/uploads\/2013\/12\/pull-request-ready-in-a-branch-called-patch-1.png\" alt=\"\" width=\"421\" height=\"170\" \/><\/a><\/p>\n<p>This is still a complicated process for the reader (3-steps, one feature branch, one pull request), but from the author side <strong>this is awesome!<\/strong> You just write and then manage incoming pull requests that improve your content.<\/p>\n<p>Anyone writing their blog posts in the open on github should consider adding the \/edit\/ links.<\/p>\n<p>&nbsp;<\/p>\n<p>Weekend project: find a way to automate this workflow process so readers don&#8217;t need to have github accounts. Maybe I could create a &#8220;shared&#8221; github account &#8220;ivans-readers,&#8221; allow for login-less-editing to happen on my own server and then see the pull requests coming from ivans-readers on the main repo.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Open is better than closed because when you work in the open the whole world can help you (or at least the portion of the world that cares about what you are doing). For books in particular, readers can be tremendously helpful by submitting typo fixes to the book. But how can users submit typos? [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[22,16],"tags":[],"class_list":["post-263","post","type-post","status-publish","format-standard","hentry","category-oer","category-writing"],"_links":{"self":[{"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/posts\/263","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/comments?post=263"}],"version-history":[{"count":1,"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/posts\/263\/revisions"}],"predecessor-version":[{"id":1616,"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/posts\/263\/revisions\/1616"}],"wp:attachment":[{"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/media?parent=263"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/categories?post=263"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/minireference.com\/blog\/wp-json\/wp\/v2\/tags?post=263"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}