{"action":"created","issue":{"url":"https://api.github.com/repos/torchbox/wagtail/issues/2311","repository_url":"https://api.github.com/repos/torchbox/wagtail","labels_url":"https://api.github.com/repos/torchbox/wagtail/issues/2311/labels{/name}","comments_url":"https://api.github.com/repos/torchbox/wagtail/issues/2311/comments","events_url":"https://api.github.com/repos/torchbox/wagtail/issues/2311/events","html_url":"https://github.com/torchbox/wagtail/pull/2311","id":138632272,"number":2311,"title":"Various typo fixes and clarity improvements for the Usage Guide","user":{"login":"coredumperror","id":413571,"avatar_url":"https://avatars.githubusercontent.com/u/413571?v=3","gravatar_id":"","url":"https://api.github.com/users/coredumperror","html_url":"https://github.com/coredumperror","followers_url":"https://api.github.com/users/coredumperror/followers","following_url":"https://api.github.com/users/coredumperror/following{/other_user}","gists_url":"https://api.github.com/users/coredumperror/gists{/gist_id}","starred_url":"https://api.github.com/users/coredumperror/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coredumperror/subscriptions","organizations_url":"https://api.github.com/users/coredumperror/orgs","repos_url":"https://api.github.com/users/coredumperror/repos","events_url":"https://api.github.com/users/coredumperror/events{/privacy}","received_events_url":"https://api.github.com/users/coredumperror/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/torchbox/wagtail/labels/Documentation","name":"Documentation","color":"006b75"},{"url":"https://api.github.com/repos/torchbox/wagtail/labels/Needs%20review","name":"Needs review","color":"fbca04"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2016-03-05T01:49:13Z","updated_at":"2016-03-06T20:52:39Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/torchbox/wagtail/pulls/2311","html_url":"https://github.com/torchbox/wagtail/pull/2311","diff_url":"https://github.com/torchbox/wagtail/pull/2311.diff","patch_url":"https://github.com/torchbox/wagtail/pull/2311.patch"},"body":"While I was re-familiarizing myself with Wagtail after a long absence from the CMS, I kept running across minor issues with the documentation. A broken link here, a missing import in an example code block there, a difficult to understand instruction, etc. Rather than just gripe about them, I set about configuring my system to let me contribute my own fixes, and then got to work carefully reading through the docs.\r\n\r\nI wasn't expecting to make anywhere near as many changes as I did, but my more careful reading of the docs revealed quite a few (usually very small) issues. I can't imagine that many of my changes will be controversial (they're mostly punctuation fixes), but there are a few I want to bring attention to.\r\n\r\nFor one, I changed the suggested Elasticsearch hosted service from Searchly to [Bonsai](https://bonsai.io/). Searchly doesn't appear to support Elasticsearch 1.x any more (I could only find a way to create a 2.20 service), which made it unusable by Wagtail. Bonsai offers a free trial, and lets you use 1.7, but I'm not really sure if this trial is time-limited, because I found a superior alternative after committing the change I made.\r\n\r\nI think the superior solution is actually to run a [Docker](https://kitematic.com/)-based Elasticsearch server locally, since it's brain-dead simple to set up using Kitematic. I was completely unfamiliar with how to use Docker when my boss suggested it, so he stepped me through the process, and my Wagtail dev site was using my Docker-hosted Elasticsearch within literally 5 minutes.\r\n\r\nSecond, I significantly re-worded the \"Using images in templates\" page. It had been confusing to me back when I first started using Wagtail in the v0.8 days, and still was when I came back and read it again. I focused on making the descriptions of each resize-rule more straightforward, and clearing up potential confusion about how height and width are ordered when talking about image dimensions. I also changed every instance of \"filter\" into \"resize-rule\". The two was being used interchangeably, which was another source of confusion.\r\n\r\nAnd on an unrelated note, can I just say that Github's diff tool is friggin' amazing for checking changes to long-form documentation? I'd been using SourceTree's diff tool, but that doesn't highlight the individual word changes and doesn't do lline-wrap, which made checking my changes very cumbersome. Do you guys know if there's an OSX desktop tool that does what Github's diff listing does?"},"comment":{"url":"https://api.github.com/repos/torchbox/wagtail/issues/comments/192989281","html_url":"https://github.com/torchbox/wagtail/pull/2311#issuecomment-192989281","issue_url":"https://api.github.com/repos/torchbox/wagtail/issues/2311","id":192989281,"user":{"login":"alexgleason","id":3639540,"avatar_url":"https://avatars.githubusercontent.com/u/3639540?v=3","gravatar_id":"","url":"https://api.github.com/users/alexgleason","html_url":"https://github.com/alexgleason","followers_url":"https://api.github.com/users/alexgleason/followers","following_url":"https://api.github.com/users/alexgleason/following{/other_user}","gists_url":"https://api.github.com/users/alexgleason/gists{/gist_id}","starred_url":"https://api.github.com/users/alexgleason/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alexgleason/subscriptions","organizations_url":"https://api.github.com/users/alexgleason/orgs","repos_url":"https://api.github.com/users/alexgleason/repos","events_url":"https://api.github.com/users/alexgleason/events{/privacy}","received_events_url":"https://api.github.com/users/alexgleason/received_events","type":"User","site_admin":false},"created_at":"2016-03-06T20:52:39Z","updated_at":"2016-03-06T20:52:39Z","body":"^ It adds clarity. I'm not sure how else you would break up those large sentences. I doubt it's for a literary effect, it just makes it easier to finish a sentence and say \"okay, I understand this\" before moving on to the next one."}}