{"action":"created","issue":{"url":"https://api.github.com/repos/kdave/btrfsmaintenance/issues/4","repository_url":"https://api.github.com/repos/kdave/btrfsmaintenance","labels_url":"https://api.github.com/repos/kdave/btrfsmaintenance/issues/4/labels{/name}","comments_url":"https://api.github.com/repos/kdave/btrfsmaintenance/issues/4/comments","events_url":"https://api.github.com/repos/kdave/btrfsmaintenance/issues/4/events","html_url":"https://github.com/kdave/btrfsmaintenance/issues/4","id":131859355,"number":4,"title":"Provide man pages for commands","user":{"login":"ieugen","id":1050920,"avatar_url":"https://avatars.githubusercontent.com/u/1050920?v=3","gravatar_id":"","url":"https://api.github.com/users/ieugen","html_url":"https://github.com/ieugen","followers_url":"https://api.github.com/users/ieugen/followers","following_url":"https://api.github.com/users/ieugen/following{/other_user}","gists_url":"https://api.github.com/users/ieugen/gists{/gist_id}","starred_url":"https://api.github.com/users/ieugen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ieugen/subscriptions","organizations_url":"https://api.github.com/users/ieugen/orgs","repos_url":"https://api.github.com/users/ieugen/repos","events_url":"https://api.github.com/users/ieugen/events{/privacy}","received_events_url":"https://api.github.com/users/ieugen/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":8,"created_at":"2016-02-06T14:21:52Z","updated_at":"2016-10-10T14:47:27Z","closed_at":null,"body":"A lot of Unix distrubutions reccommend (need) man pages for commands. Debian is one of them. \r\nThe man page format is not very friendly to write but there are tools to convert from friendlier formats to man page. \r\n\r\nOne of these is asciidoc. It has a **man** page mode that can create man pages. It can also create html pages from those documents and Github supports asciidoc. \r\n\r\nMy recommendation is to split the README.md into one asciidoc file per command and link them back. \r\n\r\nSince a2x command is available on most distributions this should be ok. \r\n\r\n[1] http://www.methods.co.nz/asciidoc/chunked/ch24.html\r\n[2] http://www.methods.co.nz/asciidoc/asciidoc.1.txt"},"comment":{"url":"https://api.github.com/repos/kdave/btrfsmaintenance/issues/comments/252642976","html_url":"https://github.com/kdave/btrfsmaintenance/issues/4#issuecomment-252642976","issue_url":"https://api.github.com/repos/kdave/btrfsmaintenance/issues/4","id":252642976,"user":{"login":"ieugen","id":1050920,"avatar_url":"https://avatars.githubusercontent.com/u/1050920?v=3","gravatar_id":"","url":"https://api.github.com/users/ieugen","html_url":"https://github.com/ieugen","followers_url":"https://api.github.com/users/ieugen/followers","following_url":"https://api.github.com/users/ieugen/following{/other_user}","gists_url":"https://api.github.com/users/ieugen/gists{/gist_id}","starred_url":"https://api.github.com/users/ieugen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ieugen/subscriptions","organizations_url":"https://api.github.com/users/ieugen/orgs","repos_url":"https://api.github.com/users/ieugen/repos","events_url":"https://api.github.com/users/ieugen/events{/privacy}","received_events_url":"https://api.github.com/users/ieugen/received_events","type":"User","site_admin":false},"created_at":"2016-10-10T14:47:27Z","updated_at":"2016-10-10T14:47:27Z","body":"It's just a policy. You need to have a man page for a system command that explains what the command does and how to use it. Otherwise, you expect people to just know about it and that does not happen.\r\n\r\nThe end goal is to make the sowftware usable by other people."}}
{"actor":{"display_login":"ieugen"}}