{"action":"created","issue":{"url":"https://api.github.com/repos/pixelgrade/components/issues/9","repository_url":"https://api.github.com/repos/pixelgrade/components","labels_url":"https://api.github.com/repos/pixelgrade/components/issues/9/labels{/name}","comments_url":"https://api.github.com/repos/pixelgrade/components/issues/9/comments","events_url":"https://api.github.com/repos/pixelgrade/components/issues/9/events","html_url":"https://github.com/pixelgrade/components/issues/9","id":292228824,"number":9,"title":"[Docs] Decide on the best way to handle documentation","user":{"login":"vladolaru","id":8830539,"avatar_url":"https://avatars3.githubusercontent.com/u/8830539?v=4","gravatar_id":"","url":"https://api.github.com/users/vladolaru","html_url":"https://github.com/vladolaru","followers_url":"https://api.github.com/users/vladolaru/followers","following_url":"https://api.github.com/users/vladolaru/following{/other_user}","gists_url":"https://api.github.com/users/vladolaru/gists{/gist_id}","starred_url":"https://api.github.com/users/vladolaru/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vladolaru/subscriptions","organizations_url":"https://api.github.com/users/vladolaru/orgs","repos_url":"https://api.github.com/users/vladolaru/repos","events_url":"https://api.github.com/users/vladolaru/events{/privacy}","received_events_url":"https://api.github.com/users/vladolaru/received_events","type":"User","site_admin":false},"labels":[{"id":802890137,"url":"https://api.github.com/repos/pixelgrade/components/labels/[Type]%20Discussion","name":"[Type] Discussion","color":"fdec05","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2018-01-28T18:59:55Z","updated_at":"2018-02-02T08:32:02Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Before building the components documentation, we should decide on the best way to do it in line with it being an open source project.\r\n\r\nI could be:\r\n1. a readme (a very long one)\r\n2. an introductory readme and a GitHub wiki\r\n3. a auto-generated Github Pages site\r\n4. a section in our guides.pixelgrade.com\r\n\r\nI would be more inclined to go with version 2 as it is the most likely to allow for community contributions to the docs."},"comment":{"url":"https://api.github.com/repos/pixelgrade/components/issues/comments/362519742","html_url":"https://github.com/pixelgrade/components/issues/9#issuecomment-362519742","issue_url":"https://api.github.com/repos/pixelgrade/components/issues/9","id":362519742,"user":{"login":"vladolaru","id":8830539,"avatar_url":"https://avatars3.githubusercontent.com/u/8830539?v=4","gravatar_id":"","url":"https://api.github.com/users/vladolaru","html_url":"https://github.com/vladolaru","followers_url":"https://api.github.com/users/vladolaru/followers","following_url":"https://api.github.com/users/vladolaru/following{/other_user}","gists_url":"https://api.github.com/users/vladolaru/gists{/gist_id}","starred_url":"https://api.github.com/users/vladolaru/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vladolaru/subscriptions","organizations_url":"https://api.github.com/users/vladolaru/orgs","repos_url":"https://api.github.com/users/vladolaru/repos","events_url":"https://api.github.com/users/vladolaru/events{/privacy}","received_events_url":"https://api.github.com/users/vladolaru/received_events","type":"User","site_admin":false},"created_at":"2018-02-02T08:32:02Z","updated_at":"2018-02-02T08:32:02Z","author_association":"CONTRIBUTOR","body":"I've decided to use the template and structure Facebook uses for their open source projects: GitHub Pages + Jekyll. I like their structure, the fact that it gives us a nice head start and also the right amount of features like the landing page, docs, blog, search.\r\n\r\nThe workflow is pretty easy (just edit and push) and it is flexible enough for all kinds of contributors. Non-technical contributors can use tools like prose.io (http://prose.io/#pixelgrade/components/tree/master/docs/_docs) or the Github editor (there are links at the end of each page) and technical people can run the site locally and use IDEs like PHPStorm to help them along."}}
{"actor":{"display_login":"vladolaru"}}