{"action":"created","issue":{"url":"https://api.github.com/repos/gatsbyjs/gatsby/issues/3159","repository_url":"https://api.github.com/repos/gatsbyjs/gatsby","labels_url":"https://api.github.com/repos/gatsbyjs/gatsby/issues/3159/labels{/name}","comments_url":"https://api.github.com/repos/gatsbyjs/gatsby/issues/3159/comments","events_url":"https://api.github.com/repos/gatsbyjs/gatsby/issues/3159/events","html_url":"https://github.com/gatsbyjs/gatsby/issues/3159","id":280328857,"number":3159,"title":"Consider removing words that shouldn't be used in educational writing from the docs (simply, easily, just)","user":{"login":"robwierzbowski","id":925735,"avatar_url":"https://avatars3.githubusercontent.com/u/925735?v=4","gravatar_id":"","url":"https://api.github.com/users/robwierzbowski","html_url":"https://github.com/robwierzbowski","followers_url":"https://api.github.com/users/robwierzbowski/followers","following_url":"https://api.github.com/users/robwierzbowski/following{/other_user}","gists_url":"https://api.github.com/users/robwierzbowski/gists{/gist_id}","starred_url":"https://api.github.com/users/robwierzbowski/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/robwierzbowski/subscriptions","organizations_url":"https://api.github.com/users/robwierzbowski/orgs","repos_url":"https://api.github.com/users/robwierzbowski/repos","events_url":"https://api.github.com/users/robwierzbowski/events{/privacy}","received_events_url":"https://api.github.com/users/robwierzbowski/received_events","type":"User","site_admin":false},"labels":[{"id":459665181,"url":"https://api.github.com/repos/gatsbyjs/gatsby/labels/Documentation","name":"Documentation","color":"fef2c0","default":false},{"id":734600061,"url":"https://api.github.com/repos/gatsbyjs/gatsby/labels/good%20first%20issue","name":"good first issue","color":"fcbfe3","default":true}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":11,"created_at":"2017-12-08T00:33:25Z","updated_at":"2018-03-06T20:30:18Z","closed_at":"2018-01-10T15:45:33Z","author_association":"NONE","body":"Pointing out how \"simple\", \"obvious\", or \"easy\" something is can have the opposite-of-intended effect. If a person doesn't understand the 'simple' code, the project can seem inaccessible. \"I don't understand this easy thing. I guess I just don't get it like other people do.\" A good resource on words to avoid is https://css-tricks.com/words-avoid-educational-writing/. Some that appear often in the Gatsby documentation are \"simply\", \"easily\", and \"just (do x)\".\r\n\r\nFor example, in the Plugins documentation:\r\n\r\n> Plugins are just Node.js packages meaning you install them like anything else in node using NPM.\r\n\r\n> Then in your site’s gatsby-config.js you simply add gatsby-transformer-json to the plugins array like:\r\n\r\nIf I wasn't familiar with node modules, or if I had any trouble or experienced a bug when adding something to the plugins array I might feel especially stupid for not \"getting\" an easy thing. IMO it's better to show something is easy than to say it is!\r\n\r\nThese could be rewritten to be more direct, not assume ease, but still be friendly:\r\n\r\n> Plugins are Node.js packages. You can install them with NPM.\r\n\r\n> Then, in your site’s gatsby-config.js add gatsby-transformer-json to the plugins array:\r\n\r\nI [removed this type of language from the Vue documentation](https://github.com/vuejs/vuejs.org/issues/1120), but don't currently have time to try the same here. Would you consider cleaning up some of the language that assumes ease?"},"comment":{"url":"https://api.github.com/repos/gatsbyjs/gatsby/issues/comments/370917453","html_url":"https://github.com/gatsbyjs/gatsby/issues/3159#issuecomment-370917453","issue_url":"https://api.github.com/repos/gatsbyjs/gatsby/issues/3159","id":370917453,"user":{"login":"KyleAMathews","id":71047,"avatar_url":"https://avatars3.githubusercontent.com/u/71047?v=4","gravatar_id":"","url":"https://api.github.com/users/KyleAMathews","html_url":"https://github.com/KyleAMathews","followers_url":"https://api.github.com/users/KyleAMathews/followers","following_url":"https://api.github.com/users/KyleAMathews/following{/other_user}","gists_url":"https://api.github.com/users/KyleAMathews/gists{/gist_id}","starred_url":"https://api.github.com/users/KyleAMathews/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/KyleAMathews/subscriptions","organizations_url":"https://api.github.com/users/KyleAMathews/orgs","repos_url":"https://api.github.com/users/KyleAMathews/repos","events_url":"https://api.github.com/users/KyleAMathews/events{/privacy}","received_events_url":"https://api.github.com/users/KyleAMathews/received_events","type":"User","site_admin":false},"created_at":"2018-03-06T20:30:18Z","updated_at":"2018-03-06T20:30:18Z","author_association":"CONTRIBUTOR","body":"Yeah https://github.com/gatsbyjs/gatsby/issues/4374"}}
{"actor":{"display_login":"KyleAMathews"}}