{"action":"closed","number":843,"pull_request":{"url":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/843","id":220917328,"node_id":"MDExOlB1bGxSZXF1ZXN0MjIwOTE3MzI4","html_url":"https://github.com/thepracticaldev/dev.to/pull/843","diff_url":"https://github.com/thepracticaldev/dev.to/pull/843.diff","patch_url":"https://github.com/thepracticaldev/dev.to/pull/843.patch","issue_url":"https://api.github.com/repos/thepracticaldev/dev.to/issues/843","number":843,"state":"closed","locked":false,"title":"Improve developer experience for previewing docs in development","user":{"login":"nholden","id":7942714,"node_id":"MDQ6VXNlcjc5NDI3MTQ=","avatar_url":"https://avatars0.githubusercontent.com/u/7942714?v=4","gravatar_id":"","url":"https://api.github.com/users/nholden","html_url":"https://github.com/nholden","followers_url":"https://api.github.com/users/nholden/followers","following_url":"https://api.github.com/users/nholden/following{/other_user}","gists_url":"https://api.github.com/users/nholden/gists{/gist_id}","starred_url":"https://api.github.com/users/nholden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nholden/subscriptions","organizations_url":"https://api.github.com/users/nholden/orgs","repos_url":"https://api.github.com/users/nholden/repos","events_url":"https://api.github.com/users/nholden/events{/privacy}","received_events_url":"https://api.github.com/users/nholden/received_events","type":"User","site_admin":true},"body":"## What type of PR is this?\r\n\r\n- [ ] Refactor\r\n- [ ] Feature\r\n- [ ] Bug Fix\r\n- [X] Documentation Update\r\n\r\n## Description\r\n\r\nThere is [no documentation on how to preview the docs in development](https://github.com/thepracticaldev/dev.to/pull/819#issuecomment-427081402). It turns out that it requires installing an npm package globally, navigating to a directory, and running a command. The `@next` version of that npm package, `gitdocs`, [is currently broken](https://github.com/timberio/gitdocs/issues/156#issuecomment-427611528), so even if someone knew all the steps to preview the docs, it's likely they would hit an error.\r\n\r\nThis change does a few things to help make previewing docs in development a less painful experience:\r\n\r\n1. It adds `gitdocs` as a dev dependency so that we can control the version and ensure it works with our configs.\r\n2. It adds a Yarn script so that serving the docs is a one liner for developers and easily configurable if we need to change the implementation in the future.\r\n3. It adds documentation about how to preview the docs.\r\n\r\n## Desktop Screenshot\r\n\r\n![screen shot 2018-10-06 at 4 16 53 pm](https://user-images.githubusercontent.com/7942714/46576623-47f5f400-c983-11e8-96e1-ee5b27717e81.png)\r\n\r\n## Added to documentation?\r\n\r\n- [X] docs.dev.to\r\n- [ ] readme\r\n- [ ] no documentation needed\r\n\r\n## What gif best describes this PR or how it makes you feel?\r\n\r\n![😎](https://media.giphy.com/media/10FwycrnAkpshW/giphy.gif)\r\n","created_at":"2018-10-06T23:20:58Z","updated_at":"2018-10-11T21:02:24Z","closed_at":"2018-10-11T21:02:24Z","merged_at":"2018-10-11T21:02:24Z","merge_commit_sha":"a6ff2f3d0c94089854b6db7f2e13337155406af3","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/843/commits","review_comments_url":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/843/comments","review_comment_url":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/comments{/number}","comments_url":"https://api.github.com/repos/thepracticaldev/dev.to/issues/843/comments","statuses_url":"https://api.github.com/repos/thepracticaldev/dev.to/statuses/c9355b1ac47d69fc0f6d6c8da4b8a394ad5534ca","head":{"label":"nholden:improve-previewing-docs","ref":"improve-previewing-docs","sha":"c9355b1ac47d69fc0f6d6c8da4b8a394ad5534ca","user":{"login":"nholden","id":7942714,"node_id":"MDQ6VXNlcjc5NDI3MTQ=","avatar_url":"https://avatars0.githubusercontent.com/u/7942714?v=4","gravatar_id":"","url":"https://api.github.com/users/nholden","html_url":"https://github.com/nholden","followers_url":"https://api.github.com/users/nholden/followers","following_url":"https://api.github.com/users/nholden/following{/other_user}","gists_url":"https://api.github.com/users/nholden/gists{/gist_id}","starred_url":"https://api.github.com/users/nholden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nholden/subscriptions","organizations_url":"https://api.github.com/users/nholden/orgs","repos_url":"https://api.github.com/users/nholden/repos","events_url":"https://api.github.com/users/nholden/events{/privacy}","received_events_url":"https://api.github.com/users/nholden/received_events","type":"User","site_admin":true},"repo":{"id":151435953,"node_id":"MDEwOlJlcG9zaXRvcnkxNTE0MzU5NTM=","name":"dev.to","full_name":"nholden/dev.to","private":false,"owner":{"login":"nholden","id":7942714,"node_id":"MDQ6VXNlcjc5NDI3MTQ=","avatar_url":"https://avatars0.githubusercontent.com/u/7942714?v=4","gravatar_id":"","url":"https://api.github.com/users/nholden","html_url":"https://github.com/nholden","followers_url":"https://api.github.com/users/nholden/followers","following_url":"https://api.github.com/users/nholden/following{/other_user}","gists_url":"https://api.github.com/users/nholden/gists{/gist_id}","starred_url":"https://api.github.com/users/nholden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nholden/subscriptions","organizations_url":"https://api.github.com/users/nholden/orgs","repos_url":"https://api.github.com/users/nholden/repos","events_url":"https://api.github.com/users/nholden/events{/privacy}","received_events_url":"https://api.github.com/users/nholden/received_events","type":"User","site_admin":true},"html_url":"https://github.com/nholden/dev.to","description":"Where programmers share ideas and help each other grow","fork":true,"url":"https://api.github.com/repos/nholden/dev.to","forks_url":"https://api.github.com/repos/nholden/dev.to/forks","keys_url":"https://api.github.com/repos/nholden/dev.to/keys{/key_id}","collaborators_url":"https://api.github.com/repos/nholden/dev.to/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/nholden/dev.to/teams","hooks_url":"https://api.github.com/repos/nholden/dev.to/hooks","issue_events_url":"https://api.github.com/repos/nholden/dev.to/issues/events{/number}","events_url":"https://api.github.com/repos/nholden/dev.to/events","assignees_url":"https://api.github.com/repos/nholden/dev.to/assignees{/user}","branches_url":"https://api.github.com/repos/nholden/dev.to/branches{/branch}","tags_url":"https://api.github.com/repos/nholden/dev.to/tags","blobs_url":"https://api.github.com/repos/nholden/dev.to/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/nholden/dev.to/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/nholden/dev.to/git/refs{/sha}","trees_url":"https://api.github.com/repos/nholden/dev.to/git/trees{/sha}","statuses_url":"https://api.github.com/repos/nholden/dev.to/statuses/{sha}","languages_url":"https://api.github.com/repos/nholden/dev.to/languages","stargazers_url":"https://api.github.com/repos/nholden/dev.to/stargazers","contributors_url":"https://api.github.com/repos/nholden/dev.to/contributors","subscribers_url":"https://api.github.com/repos/nholden/dev.to/subscribers","subscription_url":"https://api.github.com/repos/nholden/dev.to/subscription","commits_url":"https://api.github.com/repos/nholden/dev.to/commits{/sha}","git_commits_url":"https://api.github.com/repos/nholden/dev.to/git/commits{/sha}","comments_url":"https://api.github.com/repos/nholden/dev.to/comments{/number}","issue_comment_url":"https://api.github.com/repos/nholden/dev.to/issues/comments{/number}","contents_url":"https://api.github.com/repos/nholden/dev.to/contents/{+path}","compare_url":"https://api.github.com/repos/nholden/dev.to/compare/{base}...{head}","merges_url":"https://api.github.com/repos/nholden/dev.to/merges","archive_url":"https://api.github.com/repos/nholden/dev.to/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/nholden/dev.to/downloads","issues_url":"https://api.github.com/repos/nholden/dev.to/issues{/number}","pulls_url":"https://api.github.com/repos/nholden/dev.to/pulls{/number}","milestones_url":"https://api.github.com/repos/nholden/dev.to/milestones{/number}","notifications_url":"https://api.github.com/repos/nholden/dev.to/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/nholden/dev.to/labels{/name}","releases_url":"https://api.github.com/repos/nholden/dev.to/releases{/id}","deployments_url":"https://api.github.com/repos/nholden/dev.to/deployments","created_at":"2018-10-03T15:32:20Z","updated_at":"2018-10-06T23:13:25Z","pushed_at":"2018-10-11T20:48:45Z","git_url":"git://github.com/nholden/dev.to.git","ssh_url":"git@github.com:nholden/dev.to.git","clone_url":"https://github.com/nholden/dev.to.git","svn_url":"https://github.com/nholden/dev.to","homepage":"https://dev.to","size":20619,"stargazers_count":0,"watchers_count":0,"language":"Ruby","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"agpl-3.0","name":"GNU Affero General Public License v3.0","spdx_id":"AGPL-3.0","url":"https://api.github.com/licenses/agpl-3.0","node_id":"MDc6TGljZW5zZTE="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"thepracticaldev:master","ref":"master","sha":"b13c09583f7d667e16aaf7d0a2cf72136c9e8ad4","user":{"login":"thepracticaldev","id":13521919,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEzNTIxOTE5","avatar_url":"https://avatars1.githubusercontent.com/u/13521919?v=4","gravatar_id":"","url":"https://api.github.com/users/thepracticaldev","html_url":"https://github.com/thepracticaldev","followers_url":"https://api.github.com/users/thepracticaldev/followers","following_url":"https://api.github.com/users/thepracticaldev/following{/other_user}","gists_url":"https://api.github.com/users/thepracticaldev/gists{/gist_id}","starred_url":"https://api.github.com/users/thepracticaldev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thepracticaldev/subscriptions","organizations_url":"https://api.github.com/users/thepracticaldev/orgs","repos_url":"https://api.github.com/users/thepracticaldev/repos","events_url":"https://api.github.com/users/thepracticaldev/events{/privacy}","received_events_url":"https://api.github.com/users/thepracticaldev/received_events","type":"Organization","site_admin":false},"repo":{"id":73648678,"node_id":"MDEwOlJlcG9zaXRvcnk3MzY0ODY3OA==","name":"dev.to","full_name":"thepracticaldev/dev.to","private":false,"owner":{"login":"thepracticaldev","id":13521919,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEzNTIxOTE5","avatar_url":"https://avatars1.githubusercontent.com/u/13521919?v=4","gravatar_id":"","url":"https://api.github.com/users/thepracticaldev","html_url":"https://github.com/thepracticaldev","followers_url":"https://api.github.com/users/thepracticaldev/followers","following_url":"https://api.github.com/users/thepracticaldev/following{/other_user}","gists_url":"https://api.github.com/users/thepracticaldev/gists{/gist_id}","starred_url":"https://api.github.com/users/thepracticaldev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thepracticaldev/subscriptions","organizations_url":"https://api.github.com/users/thepracticaldev/orgs","repos_url":"https://api.github.com/users/thepracticaldev/repos","events_url":"https://api.github.com/users/thepracticaldev/events{/privacy}","received_events_url":"https://api.github.com/users/thepracticaldev/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/thepracticaldev/dev.to","description":"Where programmers share ideas and help each other grow","fork":false,"url":"https://api.github.com/repos/thepracticaldev/dev.to","forks_url":"https://api.github.com/repos/thepracticaldev/dev.to/forks","keys_url":"https://api.github.com/repos/thepracticaldev/dev.to/keys{/key_id}","collaborators_url":"https://api.github.com/repos/thepracticaldev/dev.to/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/thepracticaldev/dev.to/teams","hooks_url":"https://api.github.com/repos/thepracticaldev/dev.to/hooks","issue_events_url":"https://api.github.com/repos/thepracticaldev/dev.to/issues/events{/number}","events_url":"https://api.github.com/repos/thepracticaldev/dev.to/events","assignees_url":"https://api.github.com/repos/thepracticaldev/dev.to/assignees{/user}","branches_url":"https://api.github.com/repos/thepracticaldev/dev.to/branches{/branch}","tags_url":"https://api.github.com/repos/thepracticaldev/dev.to/tags","blobs_url":"https://api.github.com/repos/thepracticaldev/dev.to/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/thepracticaldev/dev.to/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/thepracticaldev/dev.to/git/refs{/sha}","trees_url":"https://api.github.com/repos/thepracticaldev/dev.to/git/trees{/sha}","statuses_url":"https://api.github.com/repos/thepracticaldev/dev.to/statuses/{sha}","languages_url":"https://api.github.com/repos/thepracticaldev/dev.to/languages","stargazers_url":"https://api.github.com/repos/thepracticaldev/dev.to/stargazers","contributors_url":"https://api.github.com/repos/thepracticaldev/dev.to/contributors","subscribers_url":"https://api.github.com/repos/thepracticaldev/dev.to/subscribers","subscription_url":"https://api.github.com/repos/thepracticaldev/dev.to/subscription","commits_url":"https://api.github.com/repos/thepracticaldev/dev.to/commits{/sha}","git_commits_url":"https://api.github.com/repos/thepracticaldev/dev.to/git/commits{/sha}","comments_url":"https://api.github.com/repos/thepracticaldev/dev.to/comments{/number}","issue_comment_url":"https://api.github.com/repos/thepracticaldev/dev.to/issues/comments{/number}","contents_url":"https://api.github.com/repos/thepracticaldev/dev.to/contents/{+path}","compare_url":"https://api.github.com/repos/thepracticaldev/dev.to/compare/{base}...{head}","merges_url":"https://api.github.com/repos/thepracticaldev/dev.to/merges","archive_url":"https://api.github.com/repos/thepracticaldev/dev.to/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/thepracticaldev/dev.to/downloads","issues_url":"https://api.github.com/repos/thepracticaldev/dev.to/issues{/number}","pulls_url":"https://api.github.com/repos/thepracticaldev/dev.to/pulls{/number}","milestones_url":"https://api.github.com/repos/thepracticaldev/dev.to/milestones{/number}","notifications_url":"https://api.github.com/repos/thepracticaldev/dev.to/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/thepracticaldev/dev.to/labels{/name}","releases_url":"https://api.github.com/repos/thepracticaldev/dev.to/releases{/id}","deployments_url":"https://api.github.com/repos/thepracticaldev/dev.to/deployments","created_at":"2016-11-13T23:02:13Z","updated_at":"2018-10-11T20:45:50Z","pushed_at":"2018-10-11T21:02:23Z","git_url":"git://github.com/thepracticaldev/dev.to.git","ssh_url":"git@github.com:thepracticaldev/dev.to.git","clone_url":"https://github.com/thepracticaldev/dev.to.git","svn_url":"https://github.com/thepracticaldev/dev.to","homepage":"https://dev.to","size":20715,"stargazers_count":7220,"watchers_count":7220,"language":"Ruby","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":638,"mirror_url":null,"archived":false,"open_issues_count":246,"license":{"key":"agpl-3.0","name":"GNU Affero General Public License v3.0","spdx_id":"AGPL-3.0","url":"https://api.github.com/licenses/agpl-3.0","node_id":"MDc6TGljZW5zZTE="},"forks":638,"open_issues":246,"watchers":7220,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/843"},"html":{"href":"https://github.com/thepracticaldev/dev.to/pull/843"},"issue":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/issues/843"},"comments":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/issues/843/comments"},"review_comments":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/843/comments"},"review_comment":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/pulls/843/commits"},"statuses":{"href":"https://api.github.com/repos/thepracticaldev/dev.to/statuses/c9355b1ac47d69fc0f6d6c8da4b8a394ad5534ca"}},"author_association":"CONTRIBUTOR","merged":true,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":{"login":"maestromac","id":15793250,"node_id":"MDQ6VXNlcjE1NzkzMjUw","avatar_url":"https://avatars2.githubusercontent.com/u/15793250?v=4","gravatar_id":"","url":"https://api.github.com/users/maestromac","html_url":"https://github.com/maestromac","followers_url":"https://api.github.com/users/maestromac/followers","following_url":"https://api.github.com/users/maestromac/following{/other_user}","gists_url":"https://api.github.com/users/maestromac/gists{/gist_id}","starred_url":"https://api.github.com/users/maestromac/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/maestromac/subscriptions","organizations_url":"https://api.github.com/users/maestromac/orgs","repos_url":"https://api.github.com/users/maestromac/repos","events_url":"https://api.github.com/users/maestromac/events{/privacy}","received_events_url":"https://api.github.com/users/maestromac/received_events","type":"User","site_admin":false},"comments":1,"review_comments":3,"maintainer_can_modify":false,"commits":2,"additions":1148,"deletions":25,"changed_files":4}}
{"actor":{"display_login":"maestromac"}}