{"action":"closed","number":19,"pull_request":{"url":"https://api.github.com/repos/SciFiFarms/althing/pulls/19","id":200470862,"node_id":"MDExOlB1bGxSZXF1ZXN0MjAwNDcwODYy","html_url":"https://github.com/SciFiFarms/althing/pull/19","diff_url":"https://github.com/SciFiFarms/althing/pull/19.diff","patch_url":"https://github.com/SciFiFarms/althing/pull/19.patch","issue_url":"https://api.github.com/repos/SciFiFarms/althing/issues/19","number":19,"state":"closed","locked":false,"title":"Add documentation","user":{"login":"TheHackmeister","id":6370350,"node_id":"MDQ6VXNlcjYzNzAzNTA=","avatar_url":"https://avatars0.githubusercontent.com/u/6370350?v=4","gravatar_id":"","url":"https://api.github.com/users/TheHackmeister","html_url":"https://github.com/TheHackmeister","followers_url":"https://api.github.com/users/TheHackmeister/followers","following_url":"https://api.github.com/users/TheHackmeister/following{/other_user}","gists_url":"https://api.github.com/users/TheHackmeister/gists{/gist_id}","starred_url":"https://api.github.com/users/TheHackmeister/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TheHackmeister/subscriptions","organizations_url":"https://api.github.com/users/TheHackmeister/orgs","repos_url":"https://api.github.com/users/TheHackmeister/repos","events_url":"https://api.github.com/users/TheHackmeister/events{/privacy}","received_events_url":"https://api.github.com/users/TheHackmeister/received_events","type":"User","site_admin":false},"body":"My requirements for documentation:\r\n\r\n1. **Easy for me to edit**. I find some wysiwyg editors hard and/or time consuming to use. For myself, that is a big barrier to actually writing documentation.\r\n2. **Git based**. Since I already have the code changes coming in through git, it makes a lot of sense to have a similar process for the documentation. \r\n3. **No authentication on my part**. When I can pass the authentication chore off to git or github, I'd rather do that.\r\n4. **Looks good**. There are too many good looking themes out in the world to put up with having something look bad.\r\n5. **Easy for other people to edit**. I figure the more streamlined the process is for getting edits to documentation the more likely other people are to contribute to documentation.\r\n\r\nI tried to use a wiki for documentation, but those that supported using git as a back end were old and didn't have a large following of users. I realized that I liked the way it was done for Home Assistant and saw that they were using Jekyll. It seems easy to understand and use, has lots of themes, and is extendable via ruby gems. There are already a number of extensions I'd like to use. It also has a docker container that supports live reloading. Sweet. \r\n\r\nThe downside is that the way Home Assistant deals with edits to their page is cumbersome and unintuitive for people not familiar with GitHub. However, there are some in browser markdown editors that I might be able to add some git or github hooks to. I think I could use github for authentication and git for creating and sending the pull request. Not a project I want to tackle right now, but it's one that might be worth it eventually. \r\n","created_at":"2018-07-10T17:31:09Z","updated_at":"2018-07-10T19:22:26Z","closed_at":"2018-07-10T19:22:26Z","merged_at":"2018-07-10T19:22:26Z","merge_commit_sha":"2f327ead733bd4b6719f4262e501dd8df23c5bb4","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/SciFiFarms/althing/pulls/19/commits","review_comments_url":"https://api.github.com/repos/SciFiFarms/althing/pulls/19/comments","review_comment_url":"https://api.github.com/repos/SciFiFarms/althing/pulls/comments{/number}","comments_url":"https://api.github.com/repos/SciFiFarms/althing/issues/19/comments","statuses_url":"https://api.github.com/repos/SciFiFarms/althing/statuses/3df99dc2a4de2b62684e5b281c151ea06be7e8c5","head":{"label":"SciFiFarms:add-wiki","ref":"add-wiki","sha":"3df99dc2a4de2b62684e5b281c151ea06be7e8c5","user":{"login":"SciFiFarms","id":35885319,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM1ODg1MzE5","avatar_url":"https://avatars3.githubusercontent.com/u/35885319?v=4","gravatar_id":"","url":"https://api.github.com/users/SciFiFarms","html_url":"https://github.com/SciFiFarms","followers_url":"https://api.github.com/users/SciFiFarms/followers","following_url":"https://api.github.com/users/SciFiFarms/following{/other_user}","gists_url":"https://api.github.com/users/SciFiFarms/gists{/gist_id}","starred_url":"https://api.github.com/users/SciFiFarms/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SciFiFarms/subscriptions","organizations_url":"https://api.github.com/users/SciFiFarms/orgs","repos_url":"https://api.github.com/users/SciFiFarms/repos","events_url":"https://api.github.com/users/SciFiFarms/events{/privacy}","received_events_url":"https://api.github.com/users/SciFiFarms/received_events","type":"Organization","site_admin":false},"repo":{"id":123229461,"node_id":"MDEwOlJlcG9zaXRvcnkxMjMyMjk0NjE=","name":"althing","full_name":"SciFiFarms/althing","owner":{"login":"SciFiFarms","id":35885319,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM1ODg1MzE5","avatar_url":"https://avatars3.githubusercontent.com/u/35885319?v=4","gravatar_id":"","url":"https://api.github.com/users/SciFiFarms","html_url":"https://github.com/SciFiFarms","followers_url":"https://api.github.com/users/SciFiFarms/followers","following_url":"https://api.github.com/users/SciFiFarms/following{/other_user}","gists_url":"https://api.github.com/users/SciFiFarms/gists{/gist_id}","starred_url":"https://api.github.com/users/SciFiFarms/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SciFiFarms/subscriptions","organizations_url":"https://api.github.com/users/SciFiFarms/orgs","repos_url":"https://api.github.com/users/SciFiFarms/repos","events_url":"https://api.github.com/users/SciFiFarms/events{/privacy}","received_events_url":"https://api.github.com/users/SciFiFarms/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SciFiFarms/althing","description":"The Althing an IoT Docker swarm stack","fork":false,"url":"https://api.github.com/repos/SciFiFarms/althing","forks_url":"https://api.github.com/repos/SciFiFarms/althing/forks","keys_url":"https://api.github.com/repos/SciFiFarms/althing/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SciFiFarms/althing/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SciFiFarms/althing/teams","hooks_url":"https://api.github.com/repos/SciFiFarms/althing/hooks","issue_events_url":"https://api.github.com/repos/SciFiFarms/althing/issues/events{/number}","events_url":"https://api.github.com/repos/SciFiFarms/althing/events","assignees_url":"https://api.github.com/repos/SciFiFarms/althing/assignees{/user}","branches_url":"https://api.github.com/repos/SciFiFarms/althing/branches{/branch}","tags_url":"https://api.github.com/repos/SciFiFarms/althing/tags","blobs_url":"https://api.github.com/repos/SciFiFarms/althing/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SciFiFarms/althing/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SciFiFarms/althing/git/refs{/sha}","trees_url":"https://api.github.com/repos/SciFiFarms/althing/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SciFiFarms/althing/statuses/{sha}","languages_url":"https://api.github.com/repos/SciFiFarms/althing/languages","stargazers_url":"https://api.github.com/repos/SciFiFarms/althing/stargazers","contributors_url":"https://api.github.com/repos/SciFiFarms/althing/contributors","subscribers_url":"https://api.github.com/repos/SciFiFarms/althing/subscribers","subscription_url":"https://api.github.com/repos/SciFiFarms/althing/subscription","commits_url":"https://api.github.com/repos/SciFiFarms/althing/commits{/sha}","git_commits_url":"https://api.github.com/repos/SciFiFarms/althing/git/commits{/sha}","comments_url":"https://api.github.com/repos/SciFiFarms/althing/comments{/number}","issue_comment_url":"https://api.github.com/repos/SciFiFarms/althing/issues/comments{/number}","contents_url":"https://api.github.com/repos/SciFiFarms/althing/contents/{+path}","compare_url":"https://api.github.com/repos/SciFiFarms/althing/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SciFiFarms/althing/merges","archive_url":"https://api.github.com/repos/SciFiFarms/althing/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SciFiFarms/althing/downloads","issues_url":"https://api.github.com/repos/SciFiFarms/althing/issues{/number}","pulls_url":"https://api.github.com/repos/SciFiFarms/althing/pulls{/number}","milestones_url":"https://api.github.com/repos/SciFiFarms/althing/milestones{/number}","notifications_url":"https://api.github.com/repos/SciFiFarms/althing/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SciFiFarms/althing/labels{/name}","releases_url":"https://api.github.com/repos/SciFiFarms/althing/releases{/id}","deployments_url":"https://api.github.com/repos/SciFiFarms/althing/deployments","created_at":"2018-02-28T04:33:23Z","updated_at":"2018-06-26T03:16:42Z","pushed_at":"2018-07-10T19:22:26Z","git_url":"git://github.com/SciFiFarms/althing.git","ssh_url":"git@github.com:SciFiFarms/althing.git","clone_url":"https://github.com/SciFiFarms/althing.git","svn_url":"https://github.com/SciFiFarms/althing","homepage":"","size":46269,"stargazers_count":1,"watchers_count":1,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":13,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":0,"open_issues":13,"watchers":1,"default_branch":"master"}},"base":{"label":"SciFiFarms:master","ref":"master","sha":"98e23433396244c06983ef7fa04462f91ec619e8","user":{"login":"SciFiFarms","id":35885319,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM1ODg1MzE5","avatar_url":"https://avatars3.githubusercontent.com/u/35885319?v=4","gravatar_id":"","url":"https://api.github.com/users/SciFiFarms","html_url":"https://github.com/SciFiFarms","followers_url":"https://api.github.com/users/SciFiFarms/followers","following_url":"https://api.github.com/users/SciFiFarms/following{/other_user}","gists_url":"https://api.github.com/users/SciFiFarms/gists{/gist_id}","starred_url":"https://api.github.com/users/SciFiFarms/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SciFiFarms/subscriptions","organizations_url":"https://api.github.com/users/SciFiFarms/orgs","repos_url":"https://api.github.com/users/SciFiFarms/repos","events_url":"https://api.github.com/users/SciFiFarms/events{/privacy}","received_events_url":"https://api.github.com/users/SciFiFarms/received_events","type":"Organization","site_admin":false},"repo":{"id":123229461,"node_id":"MDEwOlJlcG9zaXRvcnkxMjMyMjk0NjE=","name":"althing","full_name":"SciFiFarms/althing","owner":{"login":"SciFiFarms","id":35885319,"node_id":"MDEyOk9yZ2FuaXphdGlvbjM1ODg1MzE5","avatar_url":"https://avatars3.githubusercontent.com/u/35885319?v=4","gravatar_id":"","url":"https://api.github.com/users/SciFiFarms","html_url":"https://github.com/SciFiFarms","followers_url":"https://api.github.com/users/SciFiFarms/followers","following_url":"https://api.github.com/users/SciFiFarms/following{/other_user}","gists_url":"https://api.github.com/users/SciFiFarms/gists{/gist_id}","starred_url":"https://api.github.com/users/SciFiFarms/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SciFiFarms/subscriptions","organizations_url":"https://api.github.com/users/SciFiFarms/orgs","repos_url":"https://api.github.com/users/SciFiFarms/repos","events_url":"https://api.github.com/users/SciFiFarms/events{/privacy}","received_events_url":"https://api.github.com/users/SciFiFarms/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SciFiFarms/althing","description":"The Althing an IoT Docker swarm stack","fork":false,"url":"https://api.github.com/repos/SciFiFarms/althing","forks_url":"https://api.github.com/repos/SciFiFarms/althing/forks","keys_url":"https://api.github.com/repos/SciFiFarms/althing/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SciFiFarms/althing/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SciFiFarms/althing/teams","hooks_url":"https://api.github.com/repos/SciFiFarms/althing/hooks","issue_events_url":"https://api.github.com/repos/SciFiFarms/althing/issues/events{/number}","events_url":"https://api.github.com/repos/SciFiFarms/althing/events","assignees_url":"https://api.github.com/repos/SciFiFarms/althing/assignees{/user}","branches_url":"https://api.github.com/repos/SciFiFarms/althing/branches{/branch}","tags_url":"https://api.github.com/repos/SciFiFarms/althing/tags","blobs_url":"https://api.github.com/repos/SciFiFarms/althing/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SciFiFarms/althing/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SciFiFarms/althing/git/refs{/sha}","trees_url":"https://api.github.com/repos/SciFiFarms/althing/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SciFiFarms/althing/statuses/{sha}","languages_url":"https://api.github.com/repos/SciFiFarms/althing/languages","stargazers_url":"https://api.github.com/repos/SciFiFarms/althing/stargazers","contributors_url":"https://api.github.com/repos/SciFiFarms/althing/contributors","subscribers_url":"https://api.github.com/repos/SciFiFarms/althing/subscribers","subscription_url":"https://api.github.com/repos/SciFiFarms/althing/subscription","commits_url":"https://api.github.com/repos/SciFiFarms/althing/commits{/sha}","git_commits_url":"https://api.github.com/repos/SciFiFarms/althing/git/commits{/sha}","comments_url":"https://api.github.com/repos/SciFiFarms/althing/comments{/number}","issue_comment_url":"https://api.github.com/repos/SciFiFarms/althing/issues/comments{/number}","contents_url":"https://api.github.com/repos/SciFiFarms/althing/contents/{+path}","compare_url":"https://api.github.com/repos/SciFiFarms/althing/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SciFiFarms/althing/merges","archive_url":"https://api.github.com/repos/SciFiFarms/althing/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SciFiFarms/althing/downloads","issues_url":"https://api.github.com/repos/SciFiFarms/althing/issues{/number}","pulls_url":"https://api.github.com/repos/SciFiFarms/althing/pulls{/number}","milestones_url":"https://api.github.com/repos/SciFiFarms/althing/milestones{/number}","notifications_url":"https://api.github.com/repos/SciFiFarms/althing/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SciFiFarms/althing/labels{/name}","releases_url":"https://api.github.com/repos/SciFiFarms/althing/releases{/id}","deployments_url":"https://api.github.com/repos/SciFiFarms/althing/deployments","created_at":"2018-02-28T04:33:23Z","updated_at":"2018-06-26T03:16:42Z","pushed_at":"2018-07-10T19:22:26Z","git_url":"git://github.com/SciFiFarms/althing.git","ssh_url":"git@github.com:SciFiFarms/althing.git","clone_url":"https://github.com/SciFiFarms/althing.git","svn_url":"https://github.com/SciFiFarms/althing","homepage":"","size":46269,"stargazers_count":1,"watchers_count":1,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":13,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":0,"open_issues":13,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/SciFiFarms/althing/pulls/19"},"html":{"href":"https://github.com/SciFiFarms/althing/pull/19"},"issue":{"href":"https://api.github.com/repos/SciFiFarms/althing/issues/19"},"comments":{"href":"https://api.github.com/repos/SciFiFarms/althing/issues/19/comments"},"review_comments":{"href":"https://api.github.com/repos/SciFiFarms/althing/pulls/19/comments"},"review_comment":{"href":"https://api.github.com/repos/SciFiFarms/althing/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/SciFiFarms/althing/pulls/19/commits"},"statuses":{"href":"https://api.github.com/repos/SciFiFarms/althing/statuses/3df99dc2a4de2b62684e5b281c151ea06be7e8c5"}},"author_association":"CONTRIBUTOR","merged":true,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":{"login":"TheHackmeister","id":6370350,"node_id":"MDQ6VXNlcjYzNzAzNTA=","avatar_url":"https://avatars0.githubusercontent.com/u/6370350?v=4","gravatar_id":"","url":"https://api.github.com/users/TheHackmeister","html_url":"https://github.com/TheHackmeister","followers_url":"https://api.github.com/users/TheHackmeister/followers","following_url":"https://api.github.com/users/TheHackmeister/following{/other_user}","gists_url":"https://api.github.com/users/TheHackmeister/gists{/gist_id}","starred_url":"https://api.github.com/users/TheHackmeister/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TheHackmeister/subscriptions","organizations_url":"https://api.github.com/users/TheHackmeister/orgs","repos_url":"https://api.github.com/users/TheHackmeister/repos","events_url":"https://api.github.com/users/TheHackmeister/events{/privacy}","received_events_url":"https://api.github.com/users/TheHackmeister/received_events","type":"User","site_admin":false},"comments":0,"review_comments":0,"maintainer_can_modify":false,"commits":37,"additions":345,"deletions":7,"changed_files":15}}
{"actor":{"display_login":"TheHackmeister"}}